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)
- Cross reference between modules HOT 3
- Use mathml as an alternative `mathengine` HOT 3
- Anchors for admonitions
- How to create custom badges HOT 2
- Cannot find level-three cross-references HOT 6
- Got a `If you are seeing this warning/error after upgrading Documenter and this used to work`
- Doctest fix versus exceptions
- Allow setting a global `DocTestSetup` block for all `.md` files in one place
- Make search_index a JSON file
- Alternative admonition syntax?
- Support for external parsers like CommonMark HOT 2
- Profiling docs build times HOT 3
- Not Matching Versions for Subpackage Version Tags HOT 1
- docstrings in extensions HOT 1
- Add a note to contributor docs about how to format code
- Add `make` command to run prettier
- Deserialization in Julia code blocks can throw an error. HOT 2
- proposal for rendering images when last value from @example blocks HOT 5
- Generated files with Documenter.jl and julia-docdeploy have random characters included in their name, not rendering correctly HOT 4
- Feature request: Cross module links HOT 2
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.