Skip to content

Commit

Permalink
User defined page order
Browse files Browse the repository at this point in the history
To remain undocumented for the moment. Will be used later on for
auto-generated tables of contents in LaTeX and HTML documents as well as
the `mkdocs.yml` configuration file for markdown.

The pages are stored as a flat vector. Page "nesting" should be
determined automatically based on the layout of the `src/` directory
sub-folders rather being specified by the user.
  • Loading branch information
MichaelHatherly committed Jul 1, 2016
1 parent 8088a75 commit e7de659
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/Documents.jl
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ immutable User
clean :: Bool # Empty the `build` directory before starting a new build?
doctest :: Bool # Run doctests?
modules :: Set{Module} # Which modules to check for missing docs?
pages :: Vector{Any} # Ordering of document pages specified by the user.
end

"""
Expand Down Expand Up @@ -102,6 +103,7 @@ function Document(;
clean :: Bool = true,
doctest :: Bool = true,
modules :: Utilities.ModVec = Module[],
pages :: Vector = Any[],
others...
)
Utilities.check_kwargs(others)
Expand All @@ -113,7 +115,8 @@ function Document(;
format,
clean,
doctest,
Utilities.submodules(modules)
Utilities.submodules(modules),
pages,
)
internal = Internal(
Utilities.assetsdir(),
Expand Down

0 comments on commit e7de659

Please sign in to comment.