Closed timofurrer closed 8 years ago
Setup a sphinx documentation for twtxt. It contains a little more documentation then in the README.rst now.
I suggest removing the unnecessary parts from the README once the documentation is hosted somewhere - maybe http://readthedocs.org ?
Note: This is only a basic setup for the documentation to establish the documentation and it's workflow.
I added a make docs rule to the Makefile along with the all rule which runs the tests and builds the documentation.
make docs
all
The only dependency is sphinx itself.
sphinx
Setup a sphinx documentation for twtxt. It contains a little more documentation then in the README.rst now.
I suggest removing the unnecessary parts from the README once the documentation is hosted somewhere - maybe http://readthedocs.org ?
Note: This is only a basic setup for the documentation to establish the documentation and it's workflow.
I added a
make docsrule to the Makefile along with theallrule which runs the tests and builds the documentation.The only dependency is
sphinxitself.