Automatic index and cross-reference support.
Description:
- Added custom Sphinx extension (
esphome-sphinx.py) and enabled it inconf.py. - All component and device pages modified to add metadata.
- Replaced manually handled tables in
index.rstwith automatically generated tables.
The changes mean that individual rst files may be moved around directories and the extension will automatically append them to the table.
Basic cross-referencing support added to device pages to prove compliance/support.
Checklist:
- [x] Branch:
nextis for changes and new documentation that will go public with the next ESPHome release. Fixes, changes and adjustments for the current release should be created againstcurrent. - ~~Link added in
/index.rstwhen creating new documents for new components or cookbook.~~ Not applicable.
Deploy Preview for esphome ready!
| Name | Link |
|---|---|
| Latest commit | b4842aede33677e7a0732233b2534b9c01af600d |
| Latest deploy log | https://app.netlify.com/sites/esphome/deploys/62f2e6cb21bd8f0008327081 |
| Deploy Preview | https://deploy-preview-2215--esphome.netlify.app/ |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site settings.
Difficult to diagnose (and apparently impossible to replicate?) multiprocessing/parallel Sphinx issue makes this less than viable at this time.
Resolved against multiple hosts with the internal error (hopefully) diagnosed.
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.