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

Broken links in documentation #323

Closed
adrianmo opened this issue Jul 27, 2017 · 1 comment
Closed

Broken links in documentation #323

adrianmo opened this issue Jul 27, 2017 · 1 comment

Comments

@adrianmo
Copy link
Contributor

I was going through the documentation and found the following broken links:

And one question from my ignorance, is there a reason why in docs/source we keep all pages both in Markdown and RST?

@ksteinfeldt
Copy link
Contributor

To answer your question about the markdown and rst, this is because we use sphinx to build the documentation and markdown to write it. We can switch to rst only but we've kept the markdown around to encourage documentation (as rst is kind of a pain to write).

I convert the markdown to rst using pandoc. I will have a script that will take care of the conversion eventually, but I haven't gotten to it yet.

It is possible to build the markdown but it doesn't work for us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants