Comments (1)
goerz
commented on June 11, 2024
Looking at the code, this seems to be quite deliberate. But, it's not documented behavior, and I don't think it makes any sense. I agree that setting modules should just check that every public member of the given modules has its docstring rendered in the documentation, and nothing else. It should not limit docstrings that can be rendered to only those from the given modules.
I've run into this myself, and it's the reason I don't use the modules argument.
from documenter.jl.
Related Issues (20)
- Switching versions resets to the default page HOT 3
- LoadError: `makedocs` encountered an error [:missing_docs] -- terminating build before rendering. HOT 7
- Links to collapsed pages end up off-screen
- Documenter might not be expanding the example blocks in docstrings HOT 2
- Handling of ANSI foreground/background inversion is incorrect HOT 3
- Use AnnotatedIOBuffer + StyledStrings for handling ANSI codes. HOT 2
- ERROR: LoadError: PCRE compilation error: regular expression is too large HOT 9
- 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
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.