Skip to content
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

Implement RestructuredText Substitutions #422

Open
FroggyFlox opened this issue Mar 9, 2023 · 0 comments
Open

Implement RestructuredText Substitutions #422

FroggyFlox opened this issue Mar 9, 2023 · 0 comments

Comments

@FroggyFlox
Copy link
Member

RestructuredText allows for the definitions of "variables" that can then be re-used in all source files throughout the project. We should explore implementing this substitution feature to help with propagating updates or changes throughout our entire docs with a single line change.

Possible use for this could be:

  • Rockstor name + version(s)
  • base OS name + version
  • often misspelled names such as Rock-Ons, etc...
  • and more...

Note, Sphinx already include some default substitutions: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#substitutions. These include release and version that are defined in conf.py.

To define additional ones: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog

rst_prolog = """
.. |rockstor_project| replace:: The Rockstor Project
"""
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant