pybind / pybind/python_example
Building the docs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 530
- Forks
- 150
- Avg merge
- 8d 2h
- Merged PRs (30d)
- 1
Description
Hi,
I can build the docs with Sphinx using make html but when I open the html files I can't see any of the function docstrings. I'm new to Sphinx so I might be missing something.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the documented Sphinx build with make html and inspect the generated HTML alongside the Sphinx configuration. Determine why the Python function docstrings are not included; done means the generated documentation displays those docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100