[docs] Python documentation generation using Sphinx #1794
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a documentation generation process using Sphinx for the Meshroom Python API.
The process also supports including the content of markdown files that belong to the project (such as
README.md
,INSTALL.md
, etc.) for convenience using a custom directive calledfetch_md
.The instructions for building the documentation are stored in
docs/README.md
.Features list
Implementation remarks
module.rst
template for theautosummary
extension in Sphinx to have a more fine-grain control over the stub generation process and to be able to correct errors that occur during that processfetch_md
directive, the links based on relative paths are not valid anymore, so we try to re-link them (see theRelinker
class), but for now this only works for imagesbackend
variable was creating import loops, so we removed it and isolated the backend selection inmeshroom/common/__init__.py
Note
This PR is not about: