Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
sbws
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
juga
sbws
Commits
b16d5c01
Commit
b16d5c01
authored
6 years ago
by
juga
Browse files
Options
Downloads
Patches
Plain Diff
Explain how to build docs. Remove obsolete
parent
f92a1027
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
INSTALL.rst
+9
-22
9 additions, 22 deletions
INSTALL.rst
with
9 additions
and
22 deletions
INSTALL.rst
+
9
−
22
View file @
b16d5c01
...
...
@@ -80,35 +80,22 @@ To install them from ``sbws``::
pip install .[doc]
::
git clone https://github.com/pastly/simple-bw-scanner.git
cd simple-bw-scanner
git checkout v1.5.3
virtualenv -p python3 venv-editable
source venv-editable/bin/activate
pip install --process-dependency-links --editable .
sbws init
To build the documentation as HTML::
.. note::
cd docs/ && make html
Because we relay on a ``-dev`` version of stem, we need to fetch it from
git.torproject.org. Thus ``--process-dependency-links`` is necessary.
The generated HTML will be in `docs/build/`.
.. warning
::
To build the manual (``man``) pages
::
Run these commands one at a time and check for errors before continuing.
cd docs/ && make man
Updating
~~~~~~~~
The generated man pages will be in `docs/man/`.
::
To build the documentation diagrams
::
cd simple-bw-scanner
git pull
# Determine the newest released version. Assuming it is v1.5.3 ...
git checkout v1.5.3
cd docs/ && make umlsvg
.. todo::
The generated diagrams will be in `docs/build/images/`.
This doesn't update dependencies and needs to be fixed.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment