Skip to content
Snippets Groups Projects
Commit f92a1027 authored by juga's avatar juga
Browse files

Add extra dependencies for docs. Remove obsolete

parent 59b42b08
Branches
Tags
No related merge requests found
......@@ -66,27 +66,19 @@ To run the tests::
tox
Run these commands one at a time and check for errors before continuing.
Updating
~~~~~~~~
::
Installing documentation dependendencies and building it
---------------------------------------------------------
cd simple-bw-scanner
git pull
# Determine the newest released version. Assuming it is v1.5.3 ...
git checkout v1.5.3
source venv/bin/activate
pip install --process-dependency-links --upgrade-strategy eager --upgrade .
To build the documentation, extra Python dependencies are needed:
- Sphinx_
- recommonmark_
- Pylint_ (only to update the diagrams)
[OBSOLETE DO NOT FOLLOW] Virtualenv - Development
------------------------------------------------------------------------------
To install them from ``sbws``::
These are almost exactly the same. The difference is the pip command: we
install sbws in an editable state so we don't have to re-run pip every time we
make a change.
pip install .[doc]
::
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment