diff options
author | Micah Lee <micah@micahflee.com> | 2020-08-23 22:52:43 -0400 |
---|---|---|
committer | Micah Lee <micah@micahflee.com> | 2020-08-23 22:52:43 -0400 |
commit | 50dbe20270841ca24ffad4d8e033f1dc58cfd308 (patch) | |
tree | a8e991f84def1e0c55bb4b3457c42fe72dd55c3c /BUILD.md | |
parent | ddf1532eed9b9c9e0ab1219168a8dc88589a8abf (diff) | |
download | onionshare-50dbe20270841ca24ffad4d8e033f1dc58cfd308.tar.gz onionshare-50dbe20270841ca24ffad4d8e033f1dc58cfd308.zip |
Start adding documentation into the source tree
Diffstat (limited to 'BUILD.md')
-rw-r--r-- | BUILD.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -9,6 +9,7 @@ * [To make a .exe](#to-make-a-exe) * [To build the installer](#to-build-the-installer) * [Running tests](#running-tests) +* [Documentation] * [Making releases](#making-releases) * [Changelog, version, and signed git tag](#changelog-version-and-signed-git-tag) * [Linux release](#linux-release) @@ -290,6 +291,23 @@ You can also choose to wrap the tests in `xvfb-run` so that a ton of OnionShare xvfb-run poetry run ./tests/run.sh --rungui ``` +# Documentation + +To edit and build the documentation, you'll need these: + +```sh +pip3 install --user sphinx +``` + +To test te documentation: + +```sh +cd docs +make html +``` + +Then open `docs/build/html/index.html` in a browser to see it. + # Making releases This section documents the release process. Unless you're a core OnionShare developer making a release, you'll probably never need to follow it. |