Open pradyunsg opened 5 years ago
@pradyunsg how/where do we publish the docs ? Does Github run a build for Sphinx docs too ?
Also, we need some documentation on how to use the software itself. Many parts are counter-intuitive, a few things that I could only learn by looking at the code. Can that also be considered within the scope of this ticket ?
Does Github run a build for Sphinx docs too?
You can read rest files rendered locally, though they won't be rendered like sphinx. I'll setup a build on https://readthedocs.org/ :)
Can that also be considered within the scope of this ticket?
Yeps. That makes sense to me. :)
I figured it'll be a good idea to have a central location to discuss about the documentation updates I have planned for the project. The general overview is:
.. include
ReST directive)The plan is to use Sphinx and ReST for the documentation. I'll add support for Markdown documents to the Sphinx documentation but I won't be writing any new documentation using Markdown.
Feedback is welcome on this plan.