Comments (7)
I think this was a design decision
It seems like a good default though, because you can always add submodules by hand in Modules
, but you can't remove them if they're included implicitly. But it could be nice to have some syntax here to "expand" recursively to all submodules. And we should probably also document this behavior explicitly -- I don't think we do right now.
from documenter.jl.
Bit of a guess, but what happens if you do
```@autodocs
Modules = [Crossterm, Crossterm.CursorStyle, Crossterm.ClearType]
```
?
from documenter.jl.
Weirdly I'm not able to reproduce this locally:
from documenter.jl.
Explicitly specifying it solves the problem.
https://github.com/kdheepak/Crossterm.jl/actions/runs/8431301904/job/23088490229
I'm happy to close this issue but I'm still not sure why this happens? Does Documenter not handle recursive modules?
from documenter.jl.
Does Documenter not handle recursive modules
It does not. I think this was a design decision
from documenter.jl.
Weirdly I'm not able to reproduce this locally:
Your're just running doctests. That doesn't try to build the whole manual, and therefore doesn't check for missing docstrings etc.
from documenter.jl.
I thought I ran the same command I was running on GitHub actions. I believe @enumx
creates a Module
, so it would be nice to recursively expand it.
from documenter.jl.
Related Issues (20)
- 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
- RequireJS prevents integrating SwaggerUI with a user script HOT 1
- Prefer no trailing slash HOT 8
- Unsatisfiable requirements detected for package REPL HOT 11
- Improve the link vs collapse UX in docstring headers HOT 5
- Switching versions resets to the default page HOT 3
- 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`
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.