Skip to content

Commit

Permalink
Add back publishing for book + doc improve
Browse files Browse the repository at this point in the history
  • Loading branch information
phklive committed Jun 18, 2024
1 parent 8e53657 commit 596e447
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
12 changes: 5 additions & 7 deletions .github/workflows/book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ name: miden book
on:
push:
branches: [main, next]
pull_request:
types: [opened, reopened, synchronize]

jobs:
deploy:
Expand All @@ -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
9 changes: 5 additions & 4 deletions assembly/src/ast/module.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
};
Expand Down Expand Up @@ -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)
}
}

Expand Down Expand Up @@ -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()
}
Expand Down

0 comments on commit 596e447

Please sign in to comment.