Comments (6)
MichaelHatherly
commented on May 16, 2024
Do you mean all docs for a particular Function or every docstring from a module?
from documenter.jl.
hayd
commented on May 16, 2024
Ah, just functions. Sorry!
from documenter.jl.
MichaelHatherly
commented on May 16, 2024
Yeah, that would be good to have support for.
from documenter.jl.
hayd
commented on May 16, 2024
Just to clarify, as this issue was kind of vague in retrospect: I meant Lapidary functions/types should all have docstrings. :)
from documenter.jl.
MichaelHatherly
commented on May 16, 2024
Oh, I see now. Yup, planning to add some. A documentation package without documentation is a bit self-defeating...
from documenter.jl.
MichaelHatherly
commented on May 16, 2024
Most of the important functions/types are documented and added to the generated docs, closing.
from documenter.jl.
Related Issues (20)
- 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
- 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
- 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
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.