search

amol- / depot

Toolkit for storing files and attachments in web applications
MIT License
161 stars 41 forks source link

Added tox.ini with -e docs for automated build of HTML docs #41

Closed vlcinsky closed 7 years ago

vlcinsky commented 7 years ago 
modified:   docs/requirements.txt
new file:   tox.ini

Resolves issue #39

coveralls commented 7 years ago

Coverage Status

Coverage decreased (-8.4%) to 89.147% when pulling 9501d735f89158f82d51bf16eade92d05f6c0446 on vlcinsky:tox4doc into 7e9f7f4470e8792b0d657fb783d6a38b77ff194d on amol-:master.

vlcinsky commented 7 years ago

Intentionally not using make

Calling directly sphinx-build to make the build simpler to run on MS Windows, where make is not often installed.

How to build other types of documentation?

$ tox -e docs
$ source .tox/docs/bin/activate
(docs)$ cd docs
(docs)$ make pdf

Shall we put this (for some obvious) instruction into README.rst?

vlcinsky commented 7 years ago

Sorry for messing up with two different PRs mixed together.

My first commit in this PR shall be all what is related to the issue #41.

The rest relates to issue #42 (fixed by creating new branch and new PR #42)