Merge cdebfda into 748be93

.gitignore

@@ -1,2 +1,3 @@
 flarestack.egg-info
 *.pyc
+docs/build

README.md

@@ -43,7 +43,7 @@ This will resolve your environment and install all dependencies.
 
 Another option is to use *pip*
 ```bash
-pip install flarestack.
+pip install flarestack
 ```
 
  ### OPTION B: Actually, I want to see the backend code myself. Maybe I want to contribute to it!
@@ -62,6 +62,11 @@ poetry install
 ```
 This will install all packages as documented in the `poetry.lock` file.
 
+If you want to also build the documentation locally, you should install the respective dependencies:
+
+```bash
+poetry install --with docs
+```
 
 You can still use `pip` if you want to:
 

docs/source/conf.py

@@ -89,7 +89,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/source/setup.md

@@ -84,6 +84,13 @@ export FLARESTACK_SCRATCH_DIR=/path/to/scratch
 
 A folder `flarestack__data` will be created in that directory. This is where you will find plots, pickle files and other files produced by the code.
 
+## Building documentation
+*flarestack* documentation is available at [Read the Docs](flarestack.readthedocs.io), however you may want to build it locally (especially if you are contributing to the project). To do this, run `sphinx-build` from the root directory of the repository:
+
+```bash
+sphinx-build -b html docs/source/ docs/build/html
+```
+
 ## Testing *flarestack*
 
 Is *flarestack* actually working? You can check the functionality of *flarestack* with *unit tests*. There are a suite of unit tests to cover *flarestack* functionality, which can be run from the base *flarestack* directory with: