Skip to content

[MNT] Automating rendering documentation tables #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Dec 22, 2024
Merged

Conversation

lmmentel
Copy link
Owner

@lmmentel lmmentel commented Nov 17, 2024

Proposed Changes

  • Add invoke task that renders data.rst documentation page from a template and property metadata table in the database

Next steps

  • A few descriptions were corrected manually but once this is merged the docs and annotations in the db should be updated to render correctly.
  • Rendering of the description for substitutability should be updated to avoid line breaks which mess up the table format

@lmmentel
Copy link
Owner Author

After a a few attempts at making something clever at mcmtroffaes/sphinxcontrib-bibtex#353 the solution will be first render a source rst file based on db and build the docs in a subsequent step.

lmmentel and others added 3 commits December 22, 2024 22:12
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@lmmentel lmmentel marked this pull request as ready for review December 22, 2024 21:18
@lmmentel lmmentel added documentation Improvements or additions to documentation maintenance labels Dec 22, 2024
@lmmentel lmmentel self-assigned this Dec 22, 2024
@lmmentel lmmentel merged commit edfce37 into master Dec 22, 2024
20 checks passed
@lmmentel lmmentel deleted the enh/render-docs branch December 22, 2024 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant