[DOCS] Fix quickstart snippets (#177)

* Added extra line so code snippet is displayed

* Fixed CHANGELOG.rst warning

* Configure readthedocs v2

---------

Co-authored-by: andruten <[email protected]>

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

CHANGELOG.rst

@@ -71,8 +71,7 @@
 0.9.9 (2015-12-15)
 ==================
 
-* Reorder header prior to httplib request. `Host` should be always the first
-request header.
+* Reorder header prior to httplib request. `Host` should be always the first request header.
 
 
 0.9.8 (2015-12-10)

docs/quickstart.rst

@@ -45,6 +45,7 @@ Next, you'll need to create a View that extends ``revproxy.views.ProxyView`` and
 And now add your view in the ``urls.py``:
 
 .. code-block:: python
+
     from django.urls import re_path
 
     from myapp.views import TestProxyView
@@ -56,6 +57,7 @@ And now add your view in the ``urls.py``:
 Alternatively you could just use the default ProxyView as follow:
 
 .. code-block:: python
+
     from django.urls import re_path
 
     from revproxy.views import ProxyView
@@ -72,7 +74,7 @@ After starting your test server you should see the content of `http://example.co
 
         An example of a project can be found here:
         https://github.com/seocam/revproxy-test
-    
+
         The provided test project is a simple Django project that makes
-        uses of revproxy. It basically possess a view.py that extends 
+        uses of revproxy. It basically possess a view.py that extends
         from ProxyView and sets the upstream address to 'httpbin.org'.

docs/requirements.txt

@@ -0,0 +1 @@
+sphinx==7.2.6