From b3b09a6f2caa5c940184f6f127cfc19513ff09f0 Mon Sep 17 00:00:00 2001
From: Micah Lee <micah@micahflee.com>
Date: Mon, 24 Aug 2020 19:30:21 -0400
Subject: [PATCH] Switch to sphinx-rtd-theme and use sphinx-intl

---
 BUILD.md              | 15 +----------
 docs/README.md        | 30 +++++++++++++++++++++
 docs/requirements.txt |  3 +++
 docs/source/conf.py   | 62 ++++++++-----------------------------------
 docs/source/index.rst |  7 +----
 5 files changed, 46 insertions(+), 71 deletions(-)
 create mode 100644 docs/README.md
 create mode 100644 docs/requirements.txt

diff --git a/BUILD.md b/BUILD.md
index 92449a02..efc8cd27 100644
--- a/BUILD.md
+++ b/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:
-
-```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
 
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..3811f1f7
--- /dev/null
+++ b/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
+```
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..6c386dab
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+sphinx
+sphinx-rtd-theme
+sphinx-intl
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 5a928fba..2387fe30 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -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
diff --git a/docs/source/index.rst b/docs/source/index.rst
index c36374d5..6a371419 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -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