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

BUILD.md

@@ -293,20 +293,7 @@ xvfb-run poetry run ./tests/run.sh --rungui
 
 # Documentation
 
-To edit and build the documentation, you'll need these:
+To edit and build the documentation, see the [docs readme](/docs/README.md).
-
-```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
 

docs/README.md

@@ -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
+```

docs/requirements.txt

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

docs/source/conf.py

@@ -1,62 +1,22 @@
-# Configuration file for the Sphinx documentation builder.
+import sphinx_rtd_theme
-#
+import sphinx_intl
-# 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
 
-# -- 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 = copyright = "Micah Lee, et al."
-author = "Micah Lee"
+version = release = "2.3"
 
-# The full version, including alpha/beta/rc tags
+extensions = ["sphinx_rtd_theme"]
-release = "2.3"
 
-
-# -- 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 = []
 
-
+html_theme = "sphinx_rtd_theme"
-# -- Options for HTML output -------------------------------------------------
+html_logo = "_static/logo.svg"
-
+html_theme_options = {}
-# 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_static_path = ["_static"]
 
+# sphinx-intl
+locale_dirs = ["locale/"]
+gettext_compact = False

docs/source/index.rst

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