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

Convert MD docs to RST #89

Open
michaelschwier opened this issue Aug 13, 2018 · 1 comment
Open

Convert MD docs to RST #89

michaelschwier opened this issue Aug 13, 2018 · 1 comment

Comments

@michaelschwier
Copy link
Member

MD does not render very nice with Sphinx, so we should convert all MD files to RST format at some point.

@michaelschwier michaelschwier self-assigned this Aug 13, 2018
@michaelschwier
Copy link
Member Author

michaelschwier commented Aug 14, 2018

Actually, RST is also not much better (e.g. for the contribution page), so not worth the effort to convert for now.

We should think if we should strive for one format just for consistency in the docs (then must be RST, because the autodoc generation from source code documentation requires RST).

This issue is NOT URGENT AT ALL

@michaelschwier michaelschwier removed their assignment Sep 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant