You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Markdown files can be added only if m2r2 plugin is used. See this plugin documentation how to install / configure it. Bear in mind to update requirements, tox.ini files.
The bottom line here is to determine if README.md (and eventually other markdown documentation) is rewritten to RST. In such case README.rst can be easily included in sphinx documentation (if we wish to avoid duplication of content between README and Sphinx documentation).
kniklas
changed the title
Include README or other files in sphinx
Include README or other markdown files in sphinx to avoid documentation duplication
Apr 9, 2021
Markdown files can be added only if m2r2 plugin is used. See this plugin documentation how to install / configure it. Bear in mind to update
requirements
,tox.ini
files.Stack Overflow
Instead of using adding
.md
files, README and other could be rewritten to.rst
then additional plugin is not required.The text was updated successfully, but these errors were encountered: