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

Change docs files from reStructuredText to Markdown #47

Closed
berinhard opened this issue Dec 6, 2019 · 2 comments
Closed

Change docs files from reStructuredText to Markdown #47

berinhard opened this issue Dec 6, 2019 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@berinhard
Copy link
Member

All the files under docs/source/ are .rst files, which is the default format used by Sphinx. Although this is fine, it can be little bit annoying to work with this format when compared to Markdown for example.

Expected behavior

After #44, it would be nice to have a better integrity when it comes to file formats in the project. So the expected output from this issue is to have all the .rst files in our docs in .md. To do so, we have to enable Sphinx to handle Markdown files. All the info you need for this is in this session of Sphinx's docs.

@SmileyChris
Copy link
Contributor

I'd argue against bike shed re-painting changes like this. Sphinx by default expects rst. Just live with that default, like you do the choices that black makes for you.

@berinhard
Copy link
Member Author

Thanks for your comment @SmileyChris, but we still want to have a single file format for our docs files, even though it differs from Sphinx's default. The reason is that, by our experience, we notice people are more familiar with Markdown format when compared to reStructuredText.

@berinhard berinhard added the documentation Improvements or additions to documentation label Jan 20, 2020
@amureki amureki self-assigned this Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants