Comments (4)
Yes, I've thought of adding a {autodocs}
code block,
{autodocs}
Foo
Bar
which would do this (Foo
and Bar
are modules). It's not been implemented yet since I've not decided how the sorting and filtering of docs should behave. Input on that kind of thing would be valuable if you have any.
from documenter.jl.
yes, that would be great. I would sort as follows:
- Module level docs
- Exported Types
- Exported Constants
- Exported Methods
And the order for each will be the order specified in the export
list.
from documenter.jl.
And the order for each will be the order specified in the
export
list.
The actual order in which bindings are exported from a module doesn't get tracked as far as I recall, so it's probably not possible to do that without reparsing source files. names(MyMod)
returns exports sorted in alphabetical order, so that might be the best we can do. Other than that your ordering sounds good to me π.
from documenter.jl.
An basic {autodocs}
has been added in 268162c, which can be adjusted in future if need be. For now I'll close this.
from documenter.jl.
Related Issues (20)
- Unhelpful error during ?template expansion? HOT 2
- ERROR: LoadError: The repo path⦠should not contain the protocol HOT 1
- `&`-s not escape in search results
- New search window does not appear [intermittent] [bug] [regression] HOT 4
- Feature request: ANSI color output in doctests HOT 6
- Wrong `\includegraphics` image path at creating LaTeX output HOT 7
- Separate jldoctest environments HOT 1
- use of the `Base`-internal function `tuple_type_tail`
- Typing `th` into the Documenter.jl search bar throws a javascript error HOT 1
- invalid scape sequence when trying to run jldoctest with filters as standard test HOT 1
- Document Julia types of function options/kwargs
- Is `docs/instantiate.jl` obsolete? HOT 1
- Documenter not finding dynamic documentation HOT 4
- @eval returning @docs blocks don't render as documentation. HOT 5
- Feature proposal: @include blocks HOT 10
- Console shows error when metadata is not present in certain pages HOT 1
- Inter-Module at-refs? HOT 9
- Warn on (ignored) HTML comments in markdown HOT 1
- make.jl fails with git error
- Can't emit ANSI strings from `@example` block in custom writer HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from documenter.jl.