How do I output a config value in a Sphinx .rst file?

by

For the substitution of links extlinks is fine, for including arbitrary config values as asked in your question you can use rst_epilog for substitutions (or rst_prolog for text, that should be added on top of your .rst files):

In your conf.py:

my_config_value = 42
rst_epilog = '.. |my_conf_val| replace:: %d' % my_config_value

In your .rst source:

My config value is |my_conf_val|!

In your output:

My config value is 42!

More Related Contents:

  1. Sphinx’s autodoc’s automodule having apparently no effect
  2. How do I document classes without the module name?
  3. Sphinx autodoc is not automatic enough
  4. Override function declaration in autodoc for sphinx
  5. Sphinx cannot find my python files. Says ‘no module named …’
  6. Can sphinx link to documents that are not located in directories below the root document?
  7. How do I document classes imported from other modules – hence without the declaration module’s name?
  8. Automatically document all modules recursively with Sphinx autodoc
  9. How to add custom css file to Sphinx?
  10. sphinx-build fail – autodoc can’t import/find module
  11. sphinx.ext.autodoc: Keeping names of constants in signature
  12. Keeping the API updated in Sphinx
  13. How to preserve line breaks when generating python docs using sphinx
  14. How to force Sphinx to use Python 3.x interpreter
  15. How to document Python packages using Sphinx
  16. How to use sphinx automodule and exposed functions in __init__
  17. Customize sphinxdoc theme
  18. How to express multiple types for a single parameter or a return value in docstrings that are processed by Sphinx?
  19. How would I cross-reference a function generated by autodoc in Sphinx?
  20. How to validate an Email address in Django? [duplicate]
  21. Getting random row through SQLAlchemy
  22. Import python module NOT on path
  23. ValueError: Output tensors to a Model must be the output of a TensorFlow `Layer`
  24. How do I get Python libraries in pyspark?
  25. How to update one file inside zip file? [duplicate]
  26. Continuous colormap fill between two lines
  27. Split pandas dataframe in two if it has more than 10 rows
  28. Best way to choose a random file from a directory
  29. How can I implement incremental training for xgboost?
  30. Use fixed exponent in scientific notation

Leave a Comment