Improve sphinx documentation
We used to use wiki (https:/
- reference and examples will live in the same repository as code, and generated with sphinx when needed;
- we should keep using wiki to describe design choices, mind-blowing concepts, tips and tricks and best practices, and such things.
Key benefits I see:
- reference is kept near the code, so it is clear which version it describes; we can have different docs for different versions easily;
- reference documentation will benefit from cross-references, contents autogenerated from code and docstrings and other neat stuff;
- we'll get better contents published on docs.openstack.org (after https:/
- docs will go through review process, which will (hopefully) ensure its high quality and timely updates.
Blueprint information
- Status:
- Complete
- Approver:
- Joshua Harlow
- Priority:
- Medium
- Drafter:
- Ivan Melnikov
- Direction:
- Approved
- Assignee:
- None
- Definition:
- Approved
- Series goal:
- None
- Implementation:
- Implemented
- Milestone target:
- None
- Started by
- Joshua Harlow
- Completed by
- Joshua Harlow
Related branches
Related bugs
Sprints
Whiteboard
Addressed by: https:/
docs: Ingore 'taskflow.' prefix when sorting module index
Gerrit topic: https:/
Addressed by: https:/
docs: Add page describing atom arguments and results
Addressed by: https:/
Improve documentation for engines