maliput / maliput/maliput_documentation
[META] Set up sphinx documentation generator
@francocipollone is already working on this.
Since Oct 16, 2020.
- Dominant language
- CMake
- Stars
- 1
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Meta issue to track the efforts of adding [sphinx](https://www.sphinx-doc.org/en/master/index.html) documentation generator.
### 1 - Basic sphinx setup
- [x] integrate with CMake and generate a default index page. #5
### 2 - Structure
- [x] Add an structure: #5
- Installation & quickstart guide
- Developer guidelines
- Contributing
- Gallery
- Documentation
### 3 - Complete pages
- Installation & quickstart guide
- [ ] Complete
- Developer guidelines
- [x] Complete #18
- Contributing
- [ ] Complete
- Gallery #3
- [x] Add GIFs/videos representing the supported features. #7
- Documentation
- [x] Brings doxygen documents from `maliput` and `malidrive` #8
- [x] Link sphinx to those document in doxygen. #8
### 4 - Setup GIthub Pages.
_Note: The issue description will change as the work on this front grows._
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.
Assessment
This issue has not been assessed yet.