Comments (11)
kernc
commented on May 18, 2024
2
Yes, see show_source_code template tunable in config.mako.
Running pdoc with -c show_source_code=False command line argument should work.
from pdoc.
EugeniaVeselova
commented on May 18, 2024
1
It would be very helpful to highlight this method in documentation!
from pdoc.
zachvalenta
commented on May 18, 2024
1
@zachvalenta Sure. Which section do you think?
https://github.com/pdoc3/pdoc/blob/master/pdoc/documentation.md#command-line-interface -> how about here?
from pdoc.
zachvalenta
commented on May 18, 2024
worked like a charm; thanks!
from pdoc.
zachvalenta
commented on May 18, 2024
be happy to open a PR; @kernc what do you think?
from pdoc.
kernc
commented on May 18, 2024
@zachvalenta Sure. Which section do you think?
from pdoc.
kernc
commented on May 18, 2024
Maybe also a link to FAQ?
from pdoc.
zachvalenta
commented on May 18, 2024
Maybe also a link to FAQ?
I don't grok the link here; can you elaborate?
from pdoc.
kernc
commented on May 18, 2024
I meant, consider also linking to the FAQ to make similar answers even more discoverable.
from pdoc.
zachvalenta
commented on May 18, 2024
I meant, consider also linking to the FAQ to make similar answers even more discoverable.
Gotcha, that link just seems to go to a list of issues. I dug around but don't see an faq.md or section of the docs explicitly labeled 'FAQ'. Am I missing something?
from pdoc.
kernc
commented on May 18, 2024
Yes, a list of issues tagged question (no bugs or feature requests there). The format is convenient and it looks like it will stick. 😁
from pdoc.
Related Issues (20)
- Skip-errors not recogniazed HOT 1
- Support inline math with dollar `$...$` delimiters when `--config latex_math=True`
- search field wont appear in generated html file HOT 1
- generating the whole project documentation with 1 command HOT 2
- Support search in docpage HOT 2
- Wrong search hyperlinks to page sections for inherited classes HOT 1
- Strike Through Markdown not working
- PEP224 style docstring not honoured for global variable of type Callable
- HTML files should end with a newline
- Upgrade code reference warnings to errors.
- --skip-errors flag does not work
- feature request: support for headings to organize functions
- Include html containing javascript
- Using a - in folder names prevents linking
- missing docstrings of methods HOT 2
- syntax error with match-case function
- Incorrectly rendered Args section HOT 1
- Add GitHub Flavor Markdown support HOT 2
- Remove indentation in text template for markdown files
- Deprecation warning for PEP224 class variable docstrings
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 pdoc.