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

Include README or other markdown files in sphinx to avoid documentation duplication #8

Open
kniklas opened this issue Feb 26, 2021 · 1 comment
Labels

Comments

@kniklas
Copy link
Owner

kniklas commented Feb 26, 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.

@kniklas kniklas added the enhancement New feature or request label Feb 26, 2021
@kniklas kniklas added DevOps and removed enhancement New feature or request labels Apr 9, 2021
@kniklas
Copy link
Owner Author

kniklas commented Apr 9, 2021

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 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant