esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

Automatic index and cross-reference support.

Open awstanley opened this issue 3 years ago • 3 comments

Description:

  • Added custom Sphinx extension (esphome-sphinx.py) and enabled it in conf.py.
  • All component and device pages modified to add metadata.
  • Replaced manually handled tables in index.rst with 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: next is 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 against current.
  • ~~Link added in /index.rst when creating new documents for new components or cookbook.~~ Not applicable.

awstanley avatar Aug 09 '22 13:08 awstanley

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...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Aug 09 '22 14:08 netlify[bot]

Difficult to diagnose (and apparently impossible to replicate?) multiprocessing/parallel Sphinx issue makes this less than viable at this time.

awstanley avatar Aug 09 '22 15:08 awstanley

Resolved against multiple hosts with the internal error (hopefully) diagnosed.

awstanley avatar Aug 09 '22 22:08 awstanley

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.

github-actions[bot] avatar Oct 09 '22 03:10 github-actions[bot]