From 596e447e895ab08f432e2fa977b782533e0c099d Mon Sep 17 00:00:00 2001 From: Paul-Henry Kajfasz Date: Tue, 18 Jun 2024 17:22:41 +0100 Subject: [PATCH] Add back publishing for book + doc improve --- .github/workflows/book.yml | 12 +++++------- assembly/src/ast/module.rs | 9 +++++---- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml index 628f572970..3671a66b5a 100644 --- a/.github/workflows/book.yml +++ b/.github/workflows/book.yml @@ -3,8 +3,6 @@ name: miden book on: push: branches: [main, next] - pull_request: - types: [opened, reopened, synchronize] jobs: deploy: @@ -25,8 +23,8 @@ jobs: - name: Build miden book run: mdbook build docs/ - # - name: Deploy to GitHub Pages - # uses: peaceiris/actions-gh-pages@v3 - # with: - # github_token: ${{ secrets.GITHUB_TOKEN }} - # publish_dir: ./docs/book/html + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/book/html diff --git a/assembly/src/ast/module.rs b/assembly/src/ast/module.rs index d3dff4642a..d310486f4f 100644 --- a/assembly/src/ast/module.rs +++ b/assembly/src/ast/module.rs @@ -11,6 +11,7 @@ use crate::{ ast::{AstSerdeOptions, Ident}, diagnostics::{Report, SourceFile}, sema::SemanticAnalysisError, + parser::ModuleParser, ByteReader, ByteWriter, Deserializable, DeserializationError, LibraryNamespace, LibraryPath, Serializable, SourceSpan, Span, Spanned, }; @@ -276,13 +277,13 @@ impl Module { parser.parse(name, source_file) } - /// Get a [crate::parser::ModuleParser] for parsing modules of the provided [ModuleKind] + /// Get a [ModuleParser] for parsing modules of the provided [ModuleKind] /// /// This is mostly useful when you want tighter control over the parser configuration, otherwise /// it is generally more convenient to use [Module::parse_file] or [Module::parse_str] for most /// use cases. - pub fn parser(kind: ModuleKind) -> crate::parser::ModuleParser { - crate::parser::ModuleParser::new(kind) + pub fn parser(kind: ModuleKind) -> ModuleParser { + ModuleParser::new(kind) } } @@ -371,7 +372,7 @@ impl Module { self.imports.iter() } - /// Same as [Self::imports()], but returns mutable references to each import. + /// Same as [Self::imports], but returns mutable references to each import. pub fn imports_mut(&mut self) -> core::slice::IterMut<'_, Import> { self.imports.iter_mut() }