Design documents
This is where we outline the design of major parts of our project. Generally this is only available for features that have been build in the recent past, but we hope to write more of them over time.
Warning
These documents may not match the final implementation, or may be out of date.
- API v3 design document
- Better handling of docs URLs
- Build images
- Embed APIv3
- Future builder
- In-doc search UI
- Notification system: a new approach after lot of discussions
- New search API
- Proposed contents for new Sphinx guides
- Organizations
- Design of pull request builder
- Privacy levels
- Improving redirects
- Refactor
RemoteRepository
object - Secure API access from builders
- sphinxcontrib-jquery
- Allow installation of system packages
- Collect data about builds
- Read the Docs data passed to Sphinx build context
- YAML configuration file