Merge branch 'doc'

.github/workflows/main.yml

@@ -30,3 +30,6 @@ jobs:
 
     - name: Run tests
       run: hatch run test.py${{ matrix.python-version }}-${{ matrix.flask-version }}:run
+
+    - name: Check style
+      run: hatch run check:run

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc
+sphinx:
+  configuration: docs/conf.py

README.rst

@@ -4,27 +4,46 @@ Frozen-Flask
 Freezes a Flask application into a set of static files. The result can be hosted
 without any server-side software other than a traditional web server.
 
-See documentation: https://pythonhosted.org/Frozen-Flask/
+See documentation: https://frozen-flask.readthedocs.io/
 
 Contributing
 ------------
 
 * Fork the upstream repository and clone your fork
 * Create a feature branch for the thing you want to work on
 * Create a virtual environment and activate it
-* Run ``pip install -e .`` to install dependencies
-* Use ``tox`` or ``python -m flask_frozen.tests`` to run tests
-* Do your changes, make sure tests pass
-* Send a Pull Request to the upstream repository
+* Run ``pip install -e .[doc,test,check]`` to install dependencies
+* Add your changes
+* Make sure tests pass with ``pytest``
+* Make sure you followed the style guide with ``flake8`` and ``isort``
+* Send a pull request to the upstream repository
+
+You can also use `Hatch <https://hatch.pypa.io/>`_ to automatically install
+dependencies, launch tests, check style and build documentation::
+
+  $ hatch run test:run
+  $ hatch run check:run
+  $ hatch run doc:build
 
 Status
 ------
 
-**The project doesn't have an active maintainer as of now.** If you want to become one, please contact `@honzajavorek <https://github.com/honzajavorek>`__ and `@tswast <https://github.com/tswast>`__. `@SimonSapin <https://github.com/SimonSapin>`__ is pretty much inactive, but has his picture in our Hall of Fame for creating the project.
+This project is currently maintained by
+`CourtBouillon <https://www.courtbouillon.org/>`_.
+
+It’s been previously maintained by
+`@honzajavorek <https://github.com/honzajavorek>`_ and
+`@tswast <https://github.com/tswast>`_,
+and has been originally created by
+`@SimonSapin <https://github.com/SimonSapin>`_.
 
 License
 -------
 
-Frozen-Flask uses a BSD 3-clause license. See LICENSE_.
+Frozen-Flask uses a BSD 3-clause license. See LICENSE.
 
-.. _LICENSE: LICENSE
+Copyrights are retained by their contributors, no copyright assignment is
+required to contribute to Frozen-Flask. Unless explicitly stated otherwise, any
+contribution intentionally submitted for inclusion is licensed under the BSD
+3-clause license, without any additional terms or conditions. For full
+authorship information, see the version control history.

docs/_static/style.css

@@ -0,0 +1,11 @@
+h1 {
+  background: url(artwork/frozen-flask.svg) left center / contain no-repeat;
+  color: transparent;
+  font-size: 0;
+  height: 10rem;
+  margin: 2rem 0 !important;
+}
+
+h1 a {
+  display: none;
+}

docs/_templates/sidebarintro.html

@@ -1,22 +1,7 @@
 <h3>Useful Links</h3>
 <ul>
   <li><a href="https://palletsprojects.com/p/flask/">The Flask Website</a></li>
-  <li><a href="https://pypi.python.org/pypi/Frozen-Flask">
-    Frozen-Flask @ PyPI</a></li>
-  <li><a href="https://github.com/Frozen-Flask/Frozen-Flask">
-    Frozen-Flask @ github</a></li>
-  <li><a href="https://github.com/Frozen-Flask/Frozen-Flask/issues">
-    Issue Tracker</a></li>
+  <li><a href="https://pypi.python.org/pypi/Frozen-Flask">Frozen-Flask @ PyPI</a></li>
+  <li><a href="https://github.com/Frozen-Flask/Frozen-Flask">Frozen-Flask @ GitHub</a></li>
+  <li><a href="https://github.com/Frozen-Flask/Frozen-Flask/issues">Issue Tracker</a></li>
 </ul>
-
-<a href="https://github.com/Frozen-Flask/Frozen-Flask"><img
-  style="position: fixed; top: 0; right: 0; border: 0;"
-  src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"
-  alt="Fork me on GitHub" /></a>
-
-<script type="text/javascript">
-(function() {
-  var d=document,t='script',p=d.createElement(t),s=d.getElementsByTagName(t)[0];
-  p.type='text/javascript';p.async=true;p.src="http://pystil.org/pystil.js";s.parentNode.insertBefore(p,s);
-})();
-</script>