Merge pull request #82 from maykinmedia/feature/doc-fix

Fixed doc build

CONTRIBUTING.md

@@ -4,15 +4,15 @@ If you want to contribute, we ask you to follow these guidelines.
 
 ## Reporting bugs
 
-If you have encountered a bug in Open Zaak, please check if an issue already 
-exists in the list of existing [issues][issues], if such an issue does not 
+If you have encountered a bug in this project, please check if an issue already 
+exists in the list of existing [issues][issues]. If such an issue does not 
 exist, you can create a [new issue][new_issue]. When writing the bug report, 
 try to add a clear example that shows how to reproduce said bug.
 
 ## Adding new features
 
 Before making making changes to the code, we advise you to first check the list 
-of existing [issues][issues]] for this project to see if an issue for the 
+of existing [issues][issues] for this project to see if an issue for the 
 suggested changes already exists. If such an issue does not exist, you can 
 create a [new issue][new_issue]. Creating an issue gives an opportunity for 
 other developers to give tips even before you start coding.
@@ -50,16 +50,17 @@ On your local machine, create a new branch, and name it like:
 Once you have made changes or additions to the code, you can commit them (try 
 to keep the commit message descriptive but short). If an issue already exists 
 in the list of existing [issues][issues] for the changes you made, be sure to 
-format your commit message like `Fixes #<issue_id> -- description of changes made`, 
-where `<issue_id>` corresponds to the number of the issue on GitHub. To 
-demonstrate that the changes implement the new feature/fix the issue, make sure 
-to also add tests to the existing Django testsuite.
+format your commit message like 
+`:gitmoji: Fixes #<issue_id> -- description of changes made`, where 
+`<issue_id>` corresponds to the number of the issue on GitHub. To demonstrate 
+that the changes implement the new feature/fix the issue, make sure to also add 
+tests to the existing Django testsuite.
 
 ### Making a pull request
 
 If all changes have been committed, you can push the branch to your fork of the 
 repository and create a pull request to the `master` branch of this project's 
-repository. Your pull request will be reviewed, if applicable feedback will be 
+repository. Your pull request will be reviewed, if applicable, feedback will be 
 given and if everything is approved, it will be merged.
 
 ### Reviews on releases

README.NL.rst

@@ -9,8 +9,8 @@ Objecten API
 
 |build-status| |docs| |coverage| |black| |docker|
 
-API om objecten te beheren die behoren bij een bepaald objecttype. 
-[`(English version)`_]
+API om objecten te beheren die behoren bij een bepaald objecttype.
+(`English version`_)
 
 Ontwikkeld door `Maykin Media B.V.`_ in opdracht van de gemeente Utrecht.
 
@@ -21,11 +21,11 @@ Introductie
 De Objecten API heeft als doel om uiteenlopende objecten eenvoudig te kunnen
 registreren en ontsluiten in een gestandaardiseerd formaat. De Objecten API kan
 door elke organisatie ingezet worden om de voor haar interessante objecten te
-beheren. Ook kan een organisatie er voor kiezen een Objecten API in te zetten 
+beheren. Ook kan een organisatie er voor kiezen een Objecten API in te zetten
 voor Open Data, waarbij de geregistreerde objecten publiekelijk toegankelijk
 zijn.
 
-Om het formaat van objecten, de zogenoemde objecttypen, vast te leggen wordt 
+Om het formaat van objecten, de zogenoemde objecttypen, vast te leggen wordt
 gebruik gemaakt van de landelijke en/of een lokale `Objecttypen API`_.
 
 
@@ -45,7 +45,7 @@ Copyright © Maykin Media, 2020
 Licensed under the EUPL_
 
 
-.. _`(English version)`: README.rst
+.. _`English version`: README.rst
 
 .. _`Maykin Media B.V.`: https://www.maykinmedia.nl
 

README.rst

@@ -9,8 +9,8 @@ Objects API
 
 |build-status| |docs| |coverage| |black| |docker|
 
-API to manage objects belonging to a certain object type. 
-[`(Nederlandse versie)`_]
+API to manage objects belonging to a certain object type.
+(`Nederlandse versie`_)
 
 Developed by `Maykin Media B.V.`_ commissioned by the Municipality of Utrecht.
 
@@ -43,7 +43,7 @@ Copyright © Maykin Media, 2020
 Licensed under the EUPL_
 
 
-.. _`(Nederlandse versie)`: README.NL.rst
+.. _`Nederlandse versie`: README.NL.rst
 
 .. _`Maykin Media B.V.`: https://www.maykinmedia.nl
 

docs/conf.py

@@ -14,10 +14,15 @@
 
 import objects  # noqa isort:skip
 
-from objects.setup import setup_env  # noqa isort:skip
+# from objects.setup import setup_env  # noqa isort:skip
 
-setup_env()
-django.setup()
+# TODO: This needs to be enabled when we want to use autodoc to grab
+# documentation from classes and functions. However, enabling django.setup()
+# causes RTD to fail because GDAL is not present in the RTD environment.
+# See: https://github.com/readthedocs/readthedocs-docker-images/issues/114#issuecomment-570566599
+#
+# setup_env()
+# django.setup()
 
 # -- Project information -----------------------------------------------------