diff --git a/README.md b/README.md new file mode 100644 index 0000000..add3f44 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# MiniPages + +[![Apache-2.0](https://img.shields.io/pypi/l/django-minipages)](https://github.com/pascalpepe/django-minipages/blob/main/LICENSE) +[![PyPI](https://img.shields.io/pypi/v/django-minipages)](https://pypi.org/project/django-minipages/) +[![Python](https://img.shields.io/pypi/pyversions/django-minipages)](https://pypi.org/project/django-minipages/) +[![Django](https://img.shields.io/pypi/djversions/django-minipages?label=django)](https://pypi.org/project/django-minipages/) +[![CI](https://github.com/pascalpepe/django-minipages/actions/workflows/ci.yml/badge.svg)](https://github.com/pascalpepe/django-minipages/actions/workflows/ci.yml) + +MiniPages is a Django application for managing simple web pages. + + +## Status + +This project is still in its initial development stage. Anything may change at +any time. + + +## Documentation + + +- [Getting started](https://github.com/pascalpepe/django-minipages/blob/main/docs/getting-started.rst) +- [Module references](https://github.com/pascalpepe/django-minipages/tree/main/docs/references) +- [Release notes](https://github.com/pascalpepe/django-minipages/tree/main/docs/releases) + + +## License + +This project is licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0). diff --git a/README.rst b/README.rst deleted file mode 100644 index e213fd8..0000000 --- a/README.rst +++ /dev/null @@ -1,66 +0,0 @@ -========= -MiniPages -========= - -.. image:: https://img.shields.io/pypi/l/django-minipages - :alt: Apache-2.0 - :target: https://github.com/pascalpepe/django-minipages/blob/main/LICENSE - -.. image:: https://img.shields.io/pypi/v/django-minipages - :alt: PyPI - :target: https://pypi.org/project/django-minipages/ - -.. image:: https://img.shields.io/pypi/pyversions/django-minipages - :alt: Python - :target: https://pypi.org/project/django-minipages/ - -.. image:: https://img.shields.io/pypi/djversions/django-minipages?label=django - :alt: Django - :target: https://pypi.org/project/django-minipages/ - -.. image:: https://github.com/pascalpepe/django-minipages/actions/workflows/ci.yml/badge.svg - :alt: CI - :target: https://github.com/pascalpepe/django-minipages/actions/workflows/ci.yml - -MiniPages is a Django application for managing simple web pages. - -:Home: https://github.com/pascalpepe/django-minipages#readme -:Documentation: https://github.com/pascalpepe/django-minipages/tree/main/docs -:Source code: https://github.com/pascalpepe/django-minipages -:Issue tracker: https://github.com/pascalpepe/django-minipages/issues - - -Status -====== - -This project is still in its initial development stage. Anything may change at -any time. - - -Supported versions of Python and Django -======================================= - -======= ========================== -Django Python -======= ========================== -4.2 LTS 3.8, 3.9, 3.10, 3.11, 3.12 -------- -------------------------- -5.0 3.10, 3.11, 3.12 -======= ========================== - - -Documentation -============= - -The documentation of this project is available at -https://github.com/pascalpepe/django-minipages/tree/main/docs. - -- `Getting started `_ -- `Module references `_ -- `Release notes `_ - - -License -======= - -This project is licensed under the `Apache License 2.0 `_. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..226169b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,37 @@ +# MiniPages documentation + +The documentation of MiniPages is written +in [reStructuredText](https://docutils.sourceforge.io/rst.html) and built +with [Sphinx](https://www.sphinx-doc.org/en/master/). You can read it: + +- at https://github.com/pascalpepe/django-minipages/tree/main/docs, +- in plain text in this directory, +- or by building a local version on your computer. + + +## Building a local version + +1. Get the project source code: + + ```bash + git clone https://github.com/pascalpepe/django-minipages + cd django-minipages/ + ``` + +2. Install dependencies (preferably within a [Python virtual environment](https://docs.python.org/3/library/venv.html)): + + ```bash + python -m pip install -e . + python -m pip install -r docs/requirements.txt + ``` + +3. Build the documentation: + + ```bash + cd docs/ + make html + ``` + +4. The HTML pages can be found in the `_build/` directory. Open + `index.html` in your favorite web browser to start reading the + documentation. diff --git a/docs/README.rst b/docs/README.rst deleted file mode 100644 index 4da5711..0000000 --- a/docs/README.rst +++ /dev/null @@ -1,40 +0,0 @@ -======================= -MiniPages documentation -======================= - -The documentation of MiniPages is written -in `reStructuredText `_ and built -with `Sphinx `_. You can read it: - -- at https://github.com/pascalpepe/django-minipages/tree/main/docs, -- in plain text in this directory, -- or by building a local version on your computer. - - -Building a local version -======================== - -1. Get the project source code: - - .. code-block:: bash - - git clone https://github.com/pascalpepe/django-minipages - cd django-minipages/ - -2. Install dependencies (preferably within a `Python virtual environment `_): - - .. code-block:: bash - - python -m pip install -e . - python -m pip install -r docs/requirements.txt - -3. Build the documentation: - - .. code-block:: bash - - cd docs/ - make html - -4. The HTML pages can be found in the ``_build/`` directory. Open - ``index.html`` in your favorite web browser to start reading the - documentation. diff --git a/docs/conf.py b/docs/conf.py index e5c08ec..0a0ff00 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,7 @@ project = "MiniPages" author = "Pascal Pepe" -copyright = f"2017-2023, {author}" +copyright = f"2017-2024, {author}" release = "0.2.0" @@ -37,7 +37,7 @@ ] templates_path = [] -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "README.rst"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "README.md"] # -- Options for HTML output ------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index df3cc30..b6072fc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,11 +4,6 @@ MiniPages documentation MiniPages is a reusable Django application for managing simple web pages. -:Home: https://github.com/pascalpepe/django-minipages -:Documentation: https://github.com/pascalpepe/django-minipages/tree/main/docs -:Source code: https://github.com/pascalpepe/django-minipages -:Issue tracker: https://github.com/pascalpepe/django-minipages/issues - .. note:: This project is still in its initial development stage. Anything may change @@ -25,3 +20,10 @@ Contents references/index releases/index license + +.. toctree:: + :hidden: + :caption: Project Links + + GitHub + PyPI diff --git a/docs/releases/0.2.0.rst b/docs/releases/0.2.0.rst index 74d06e5..f598a7a 100644 --- a/docs/releases/0.2.0.rst +++ b/docs/releases/0.2.0.rst @@ -57,4 +57,4 @@ Documentation ============= - Changed Sphinx documentation theme to `Furo `_. -- Updated Sphinx to version 6.1. +- Updated Sphinx to version 7.2. diff --git a/docs/requirements.txt b/docs/requirements.txt index ac6ee67..2cd138e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ -Sphinx==6.1.* -furo==2022.12.7 +Sphinx==7.2.* +furo==2024.1.29 diff --git a/pyproject.toml b/pyproject.toml index b388ed6..55e4a09 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "hatchling.build" [project] name = "django-minipages" description = "Django application for managing simple web pages." -readme = "README.rst" +readme = "README.md" requires-python = ">=3.8" license = { text = "Apache-2.0" } keywords = ["django", "pages"] diff --git a/src/minipages/__about__.py b/src/minipages/__about__.py index ac03efb..ec92bc4 100644 --- a/src/minipages/__about__.py +++ b/src/minipages/__about__.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/__init__.py b/src/minipages/__init__.py index bd617f2..101ee1e 100644 --- a/src/minipages/__init__.py +++ b/src/minipages/__init__.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/admin.py b/src/minipages/admin.py index f503c72..65f2027 100644 --- a/src/minipages/admin.py +++ b/src/minipages/admin.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/apps.py b/src/minipages/apps.py index e0731cf..be061f5 100644 --- a/src/minipages/apps.py +++ b/src/minipages/apps.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/locale/en/LC_MESSAGES/django.po b/src/minipages/locale/en/LC_MESSAGES/django.po index 0833f99..7d339e5 100644 --- a/src/minipages/locale/en/LC_MESSAGES/django.po +++ b/src/minipages/locale/en/LC_MESSAGES/django.po @@ -1,6 +1,6 @@ # English translation of MiniPages. # -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/locale/fr/LC_MESSAGES/django.po b/src/minipages/locale/fr/LC_MESSAGES/django.po index 7d086e7..9963c91 100644 --- a/src/minipages/locale/fr/LC_MESSAGES/django.po +++ b/src/minipages/locale/fr/LC_MESSAGES/django.po @@ -1,6 +1,6 @@ # French translation of MiniPages. # -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/migrations/0001_initial.py b/src/minipages/migrations/0001_initial.py index ab192f4..d4a2e08 100644 --- a/src/minipages/migrations/0001_initial.py +++ b/src/minipages/migrations/0001_initial.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/models.py b/src/minipages/models.py index 6bb38f3..3cb26e7 100644 --- a/src/minipages/models.py +++ b/src/minipages/models.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/urls.py b/src/minipages/urls.py index d3b4c05..e11b83c 100644 --- a/src/minipages/urls.py +++ b/src/minipages/urls.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/src/minipages/views.py b/src/minipages/views.py index e5a2a4a..d6f91c0 100644 --- a/src/minipages/views.py +++ b/src/minipages/views.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/tests/settings.py b/tests/settings.py index bbcd9ac..240e45e 100644 --- a/tests/settings.py +++ b/tests/settings.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/tests/test_models.py b/tests/test_models.py index b57016b..f37c540 100644 --- a/tests/test_models.py +++ b/tests/test_models.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/tests/test_views.py b/tests/test_views.py index 04826cf..dd118a2 100644 --- a/tests/test_views.py +++ b/tests/test_views.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/tests/urls.py b/tests/urls.py index f8256ca..e38b9ad 100644 --- a/tests/urls.py +++ b/tests/urls.py @@ -1,4 +1,4 @@ -# Copyright 2017-2023 Pascal Pepe +# Copyright 2017-2024 Pascal Pepe # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License.