Can sphinx link to documents that are not located in directories below the root document?

by

Yes, you can!

In lieu of a symlink (which won’t work on Windows), create a stub document that has nothing in it but a .. include:: directive.

I ran into this trying to link to a README file that was in the top of the source tree. I put the following in a file called readme_link.rst:

.. include:: ../README

Then in index.rst, I made the toctree look like:

Contents:

.. toctree::
   :maxdepth: 2

   readme_link
   other_stuff

And now I have a link to my release notes on my index page.

Thanks to http://reinout.vanrees.org/weblog/2010/12/08/include-external-in-sphinx.html for the suggestion

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. Symlinks on windows?
  7. How to symlink python in Homebrew?
  8. How do I document classes imported from other modules – hence without the declaration module’s name?
  9. Automatically document all modules recursively with Sphinx autodoc
  10. How to add custom css file to Sphinx?
  11. sphinx-build fail – autodoc can’t import/find module
  12. How do I output a config value in a Sphinx .rst file?
  13. sphinx.ext.autodoc: Keeping names of constants in signature
  14. Keeping the API updated in Sphinx
  15. How to preserve line breaks when generating python docs using sphinx
  16. How to force Sphinx to use Python 3.x interpreter
  17. How to document Python packages using Sphinx
  18. How to use sphinx automodule and exposed functions in __init__
  19. Customize sphinxdoc theme
  20. How to express multiple types for a single parameter or a return value in docstrings that are processed by Sphinx?
  21. How would I cross-reference a function generated by autodoc in Sphinx?
  22. How to rename a file in python
  23. Quick way to upsample numpy array by nearest neighbor tiling [duplicate]
  24. How to redirect print statements to Tkinter text widget
  25. Multiprocessing a for loop?
  26. Securely Erasing Password in Memory (Python)
  27. R and Python in one Jupyter notebook
  28. Convert decimal to binary in python [duplicate]
  29. Python SQLite3 SQL Injection Vulnerable Code
  30. Time Series Decomposition function in Python

Leave a Comment