Closed Chris-Johnston closed 5 years ago
I suppose we can have a look at OpenWISP and generate a simple site using sphinx
. What do you think @Chris-Johnston ?
I've seen that Sphinx and Read the Docs are pretty common with stuff like this, and I actually had started setting it up in #103 , but never got around to getting anything implemented yet. Might be something that I come back to in a few days.
Great @Chris-Johnston I suppose having a separate repo for docs would be easier to maintain.
It's not actually going to be in a separate repo, like the openwisp2-docs. The docs will be under a docs
directory, similar to how tweepy does it.
Thanks for the suggestion for using sphinx though, I think that may be the way to go.
I had a look at tweepy. That is also a good idea. We can look at openwisp2-docs README
and add a similar one to the docs folder for giving the users an understanding of making contributions and an intro to sphinx
.
Definitely, contribution and getting started guides are both important to have, but haven't been a focus of development yet. I want to focus on cleaning up the code base a bit before focusing on other contributions.
Sure! I am happy to help with the docs once you are done
cleaning up the code base
Fixed as of #103 . Now using Travis CI to build Sphinx docs, which are deployed to GH pages.
This project as a whole could use more documentation in the form of a website. Stuff that needs to be documented includes:
There are a few options that I'm considering for this: