Skip to content
This repository has been archived by the owner on Oct 18, 2024. It is now read-only.

Switch documentation from rst to md, improve examples and readability. #10

Open
entendu opened this issue Dec 3, 2015 · 1 comment
Open

Comments

@entendu
Copy link
Contributor

entendu commented Dec 3, 2015

Is there a good reason to use a Python-y doc format for a PHP project on github? Markdown seems like the natural choice.

@xiongchiamiov
Copy link
Contributor

To come back to this years later :), because Read The Docs was a good documentation-hosting site, it uses Sphinx, and Sphinx at the time only supported ReST.

Sphinx appears to have some level of markdown support these days, so that would be a thing to look into. Alternatively, mkdocs might be a sufficient replacement for RTD and could be published onto GitHub Pages. I don't know offhand what the api documentation story is for mkdocs.

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

No branches or pull requests

2 participants