Merge pull request #879 from adamtheturtle/doc-contributing

adamtheturtle · web-flow · commit 17f31ccb280d · 2018-10-06T10:50:33.000+01:00
Sphinxify docs
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -17,7 +17,7 @@ Install Python dependencies in a virtual environment.
     pip install --editable .[dev]
 
 Spell checking requires ``enchant``.
-This can be installed on macOS, for example, with `Homebrew <http://brew.sh>`__:
+This can be installed on macOS, for example, with `Homebrew <https://brew.sh>`__:
 
 .. code:: sh
 
@@ -69,9 +69,9 @@ Travis CI
 ---------
 
 Tests are run on Travis CI.
-The configuration for this is in ``.travis.yml``.
+The configuration for this is in :file:`.travis.yml`.
 
 Performing a release
 --------------------
 
-See release process in the full documentation.
+See :doc:`release-process`.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,5 +5,6 @@ VWS Python
    :maxdepth: 3
 
    exceptions
+   contributing
    release-process
    changelog
diff --git a/spelling_private_dict.txt b/spelling_private_dict.txt
@@ -1,9 +1,11 @@
+Ubuntu
 api
 args
 ascii
 bool
 boolean
 bytesio
+changelog
 chunked
 cmyk
 connectionerror
@@ -31,6 +33,9 @@ keyring
 kib
 kwargs
 linters
+linting
+linting
+macOS
 mb
 metadata
 mib
