Skip to content

Commit

Permalink
Revert "Update documentation"
Browse files Browse the repository at this point in the history
  • Loading branch information
liZe committed Nov 10, 2023
1 parent b3713dc commit e406596
Show file tree
Hide file tree
Showing 13 changed files with 275 additions and 189 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,3 @@ jobs:

- name: Run tests
run: hatch run test.py${{ matrix.python-version }}-${{ matrix.flask-version }}:run

- name: Check style
run: hatch run check:run
13 changes: 0 additions & 13 deletions .readthedocs.yaml

This file was deleted.

25 changes: 25 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Frozen-Flask is written and maintained by Simon Sapin and
various contributors:

Development Lead
----------------

- Simon Sapin <simon.sapin@exyr.org>

Patches and Suggestions
-----------------------

- Amit Bansil
- Ben Vinegar
- Christopher Roach
- David Baumgold
- Glwadys Fayolle
- Google Inc.
- Jim Gray
- Jochen Kupperschmidt
- Jökull Sólberg Auðunsson
- Ron DuPlain
- Rui Abreu Ferreira
- Thomas Waldmann
- Tim Swast <swast@google.com>
- vaus
35 changes: 8 additions & 27 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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://frozen-flask.readthedocs.io/
See documentation: https://pythonhosted.org/Frozen-Flask/

Build Status
------------
Expand All @@ -21,38 +21,19 @@ 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 .[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
* 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

Status
------

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>`_.
**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.

License
-------

Frozen-Flask uses a BSD 3-clause license. See LICENSE.
Frozen-Flask uses a BSD 3-clause license. See 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.
.. _LICENSE: LICENSE
11 changes: 0 additions & 11 deletions docs/_static/style.css

This file was deleted.

21 changes: 18 additions & 3 deletions docs/_templates/sidebarintro.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
<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>
1 change: 1 addition & 0 deletions docs/_themes
Submodule _themes added at 0269f3
Loading

0 comments on commit e406596

Please sign in to comment.