Generate docstrings for sphinx without building the library
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 18k
- Forks
- 2.3k
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 10
Description
I should mention that this is more a question than an issue.
Issue description
I want to generate source code docs with sphinx for the pybind11 interface of a project. It works fine if I compile the whole project (since the pybind11 interface links to most of the project) and sphinx extracts the docs strings from the .so file. However I want to use readthedocs for automatic doc generation and don't want to build the whole project just for the documentation.
Is it possible to just generate the docstrings with pybind11, so that I can create my sphinx doc without compiling the project?
Contributor guide
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
The issue names no repository files, tests, or entry points. Start by examining the pybind11 interface's Sphinx and docstring workflow alongside the ReadTheDocs build setup; done means determining whether documentation can be generated without compiling the full project and documenting the supported path or limitation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100