Switch to sphinx-rtd-theme and use sphinx-intl

This commit is contained in:
Micah Lee 2020-08-24 19:30:21 -04:00
parent 50dbe20270
commit b3b09a6f2c
No known key found for this signature in database
GPG Key ID: 403C2657CD994F73
5 changed files with 46 additions and 71 deletions

View File

@ -293,20 +293,7 @@ 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.
To edit and build the documentation, see the [docs readme](/docs/README.md).
# Making releases

30
docs/README.md Normal file
View File

@ -0,0 +1,30 @@
# OnionShare Documentation
All these commands must be run from the `docs` folder.
You must have the python dependencies installed to build the docs:
```sh
pip3 install --user requirements.txt
```
To build HTML docs:
```sh
make html
```
Then open `docs/build/html/index.html` in a browser to see it.
To prepare translations:
```sh
# Generate .po files in build/gettext
make gettext
# Create a new blank German locale in source/locale, based on .po files
sphinx-intl update -p build/gettext -l de
# Build German translated document
make -e SPHINXOPTS="-D language='de'" html
```

3
docs/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx
sphinx-rtd-theme
sphinx-intl

View File

@ -1,62 +1,22 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import sphinx_rtd_theme
import sphinx_intl
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = "OnionShare"
copyright = "2020, Micah Lee"
author = "Micah Lee"
author = copyright = "Micah Lee, et al."
version = release = "2.3"
# The full version, including alpha/beta/rc tags
release = "2.3"
extensions = ["sphinx_rtd_theme"]
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "alabaster"
html_theme_options = {
"description": "An open source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network",
"github_user": "micahflee",
"github_repo": "onionshare",
"fixed_sidebar": True,
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_theme = "sphinx_rtd_theme"
html_logo = "_static/logo.svg"
html_theme_options = {}
html_static_path = ["_static"]
# sphinx-intl
locale_dirs = ["locale/"]
gettext_compact = False

View File

@ -1,12 +1,7 @@
How to Use OnionShare
=====================
.. image:: _static/logo.svg
:height: 200px
:width: 200px
Getting Started
---------------
OnionShare is an open source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network.
.. toctree::
:maxdepth: 2