Merge pull request #308 from joke2k/feature/package-description

Restructure project documentation

.github/workflows/cs.yml

@@ -4,13 +4,15 @@ on:
   push:
     branches:
       - develop
+      - main
       - 'feature/**'
       - 'release/**'
       - 'fix/**'
 
   pull_request:
     branches:
       - develop
+      - main
 
 jobs:
   lint:

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - develop
+      - main
+      - 'feature/**'
+      - 'release/**'
+      - 'fix/**'
+
+  pull_request:
+    branches:
+      - develop
+      - main
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    name: Build and test package documentation
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2.3.4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2.2.2
+        with:
+          python-version: '3.9'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip --use-feature=in-tree-build install tox tox-gh-actions
+
+      - name: Build and test package documentation
+        run: tox -e docs

.gitignore

@@ -14,6 +14,7 @@
 # https://help.github.com/articles/ignoring-files/#create-a-global-gitignore
 
 # Directories to ignore (do not add trailing '/'s, they skip symlinks).
+/.pytest_cache
 /.tox
 /build
 /dist

AUTHORS.rst

@@ -1,120 +1,19 @@
-Generated by https://github.com/pydanny/contributors
+Credits
+=======
 
-  * (◕ᴥ◕) (`@ratson`_)
-  * Adam Dobrawy (`@ad-m`_)
-  * Andrea Crotti (`@AndreaCrotti`_)
-  * Andrew (`@AndBondStyle`_)
-  * Antoine Lorence (`@alorence`_)
-  * Artem.Bernatskyy (`@ArtemBernatskyy`_)
-  * Bachynin Ivan (`@vaniakosmos`_)
-  * Bart Moelans (`@bmoelans`_)
-  * Brian May (`@brianmay`_)
-  * Bruno Alla (`@browniebroke`_)
-  * Chad Saunders (`@chadsaun`_)
-  * Daniel van Flymen (`@dvf`_)
-  * Daniele Faraglia (`@joke2k`_)
-  * David (`@ddiazpinto`_)
-  * David Karchmer (`@dkarchmer`_)
-  * dennis again (`@immerrr`_)
-  * Dinesh Kumar Sharma (`@dinesh829269`_)
-  * Dustin Wyatt (`@dmwyatt`_)
-  * Ed Morley (`@edmorley`_)
-  * Federico Martinez (`@federicoemartinez`_)
-  * `@fedetorre`_
-  * Flavio Curella (`@fcurella`_)
-  * Florian Demmer (`@fdemmer`_)
-  * Ivan Anishchuk (`@IvanAnishchuk`_)
-  * Jack Cushman (`@jcushman`_)
-  * Jafnee (`@Jafnee`_)
-  * Jake Merdich (`@jmerdich`_)
-  * James Hiew (`@jameshiew`_)
-  * Jason Kraus (`@zbyte64`_)
-  * Jaye Doepke (`@jtdoepke`_)
-  * jess (`@monkeywithacupcake`_)
-  * Jimmy Merrild Krag (`@beruic`_)
-  * jjlorenzo (`@jjlorenzo`_)
-  * Johannes Hoppe (`@codingjoe`_)
-  * `@kakkulap`_
-  * `@konoufo`_
-  * konstin (`@konstin`_)
-  * Kosei Kitahara (`@Surgo`_)
-  * Mark Heppner (`@mheppner`_)
-  * Mark Rogaski (`@mrogaski`_)
-  * Matthew Jacobi (`@oppianmatt`_)
-  * Max Arnold (`@max-arnold`_)
-  * Neil Lyons (`@nwjlyons`_)
-  * `@nguyentrantuan`_
-  * Nick Travis (`@ntravis`_)
-  * Norman Schenck (`@normoes`_)
-  * Philippe Luickx (`@philippeluickx`_)
-  * pyup.io bot (`@pyup-bot`_)
-  * Riccardo Magliocchetti (`@xrmx`_)
-  * Santtu Pajukanta (`@japsu`_)
-  * Sardorbek Imomaliev (`@imomaliev`_)
-  * Simon Lundmark Ornstein (`@simlun`_)
-  * `@thaxy`_
-  * Thinh Nguyen (`@Taik`_)
-  * Tibo Beijen (`@TBeijen`_)
-  * Timothy Allen (`@FlipperPA`_)
-  * `@VKen`_
-  * Vladislav Bakin (`@mixkorshun`_)
-  * Vu Chau (`@vuchau`_)
-.. _`@vaniakosmos`: https://github.com/vaniakosmos
-.. _`@mixkorshun`: https://github.com/mixkorshun
-.. _`@thaxy`: https://github.com/thaxy
-.. _`@max-arnold`: https://github.com/max-arnold
-.. _`@brianmay`: https://github.com/brianmay
-.. _`@pyup-bot`: https://github.com/pyup-bot
-.. _`@fdemmer`: https://github.com/fdemmer
-.. _`@Surgo`: https://github.com/Surgo
-.. _`@dmwyatt`: https://github.com/dmwyatt
-.. _`@nwjlyons`: https://github.com/nwjlyons
-.. _`@AndBondStyle`: https://github.com/AndBondStyle
-.. _`@zbyte64`: https://github.com/zbyte64
-.. _`@fedetorre`: https://github.com/fedetorre
-.. _`@normoes`: https://github.com/normoes
-.. _`@alorence`: https://github.com/alorence
-.. _`@ddiazpinto`: https://github.com/ddiazpinto
-.. _`@simlun`: https://github.com/simlun
-.. _`@jcushman`: https://github.com/jcushman
-.. _`@ntravis`: https://github.com/ntravis
-.. _`@ratson`: https://github.com/ratson
-.. _`@jmerdich`: https://github.com/jmerdich
-.. _`@joke2k`: https://github.com/joke2k
-.. _`@edmorley`: https://github.com/edmorley
-.. _`@konoufo`: https://github.com/konoufo
-.. _`@dkarchmer`: https://github.com/dkarchmer
-.. _`@chadsaun`: https://github.com/chadsaun
-.. _`@immerrr`: https://github.com/immerrr
-.. _`@dvf`: https://github.com/dvf
-.. _`@jtdoepke`: https://github.com/jtdoepke
-.. _`@Taik`: https://github.com/Taik
-.. _`@Jafnee`: https://github.com/Jafnee
-.. _`@dinesh829269`: https://github.com/dinesh829269
-.. _`@federicoemartinez`: https://github.com/federicoemartinez
-.. _`@VKen`: https://github.com/VKen
-.. _`@vuchau`: https://github.com/vuchau
-.. _`@xrmx`: https://github.com/xrmx
-.. _`@monkeywithacupcake`: https://github.com/monkeywithacupcake
-.. _`@oppianmatt`: https://github.com/oppianmatt
-.. _`@beruic`: https://github.com/beruic
-.. _`@fcurella`: https://github.com/fcurella
-.. _`@jameshiew`: https://github.com/jameshiew
-.. _`@imomaliev`: https://github.com/imomaliev
-.. _`@japsu`: https://github.com/japsu
-.. _`@IvanAnishchuk`: https://github.com/IvanAnishchuk
-.. _`@konstin`: https://github.com/konstin
-.. _`@nguyentrantuan`: https://github.com/nguyentrantuan
-.. _`@mheppner`: https://github.com/mheppner
-.. _`@browniebroke`: https://github.com/browniebroke
-.. _`@AndreaCrotti`: https://github.com/AndreaCrotti
-.. _`@ad-m`: https://github.com/ad-m
-.. _`@bmoelans`: https://github.com/bmoelans
-.. _`@jjlorenzo`: https://github.com/jjlorenzo
-.. _`@kakkulap`: https://github.com/kakkulap
-.. _`@codingjoe`: https://github.com/codingjoe
-.. _`@ArtemBernatskyy`: https://github.com/ArtemBernatskyy
-.. _`@mrogaski`: https://github.com/mrogaski
-.. _`@philippeluickx`: https://github.com/philippeluickx
-.. _`@FlipperPA`: https://github.com/FlipperPA
-.. _`@TBeijen`: https://github.com/TBeijen
+``django-environ`` was initially created by `Daniele Faraglia <https://github.com/joke2k>`_
+and currently maintained by `Serghei Iakovlev <https://github.com/sergeyklay/>`_.
+
+A full list of contributors can be found in `GitHub <https://github.com/joke2k/django-environ/graphs/contributors>`_.
+
+The existence of ``django-environ`` would have been impossible without these
+projects:
+
+- `rconradharris/envparse <https://github.com/rconradharris/envparse>`_
+- `jacobian/dj-database-url <https://github.com/jacobian/dj-database-url>`_
+- `migonzalvar/dj-email-url <https://github.com/migonzalvar/dj-email-url>`_
+- `ghickman/django-cache-url <https://github.com/ghickman/django-cache-url>`_
+- `dstufft/dj-search-url <https://github.com/dstufft/dj-search-url>`_
+- `julianwachholz/dj-config-url <https://github.com/julianwachholz/dj-config-url>`_
+- `nickstenning/honcho <https://github.com/nickstenning/honcho>`_
+- `rconradharris/envparse <https://github.com/rconradharris/envparse>`_

CHANGELOG.rst

@@ -5,12 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is *inspired* by `Keep a Changelog <http://keepachangelog.com/en/1.0.0/>`_
 and this project adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.
 
-`unreleased`_
---------------------------
+`v0.6.0`_ - 00-Unreleased-0000
+------------------------------
 Added
 +++++
   - Python 3.9, 3.10 and pypy 3.7 are now supported
   - Django 3.1 and 3.2 are now supported
+  - Add missed classifiers to ``setup.py``
 
 Fixed
 +++++
@@ -20,6 +21,8 @@ Changed
 +++++++
   - Refactor tests to use pytest and follow DRY
   - Move CI to GitHub Actions
+  - Restructure project documentation
+  - Build and test package documentation as a part of CI pipeline
 
 
 `v0.5.0`_ - 30-August-2021
@@ -155,7 +158,7 @@ Added
   - Initial release
 
 
-.. _unreleased: https://github.com/joke2k/django-environ/compare/v0.5.0...develop
+.. _v0.6.0: https://github.com/joke2k/django-environ/compare/v0.5.0...develop
 .. _v0.5.0: https://github.com/joke2k/django-environ/compare/v0.4.5...v0.5.0
 .. _v0.4.5: https://github.com/joke2k/django-environ/compare/v0.4.4...v0.4.5
 .. _v0.4.4: https://github.com/joke2k/django-environ/compare/v0.4.3...v0.4.4

CONTRIBUTING.rst

@@ -0,0 +1,17 @@
+Contributing
+============
+
+If you would like to contribute to ``django-environ``, please take a look at the
+`current issues <https://github.com/joke2k/django-environ/issues>`_.  If there is
+a bug or feature that you want but it isn't listed, make an issue and work on it.
+
+How to Contribute
+-----------------
+
+1. Check for open issues or open a fresh issue to start a discussion around a
+   feature idea or a bug.
+2. Fork `the repository <https://github.com/joke2k/django-environ>`_ on GitHub
+   to start making your changes to the **develop** branch (or branch off of it).
+3. Write a test which shows that the bug was fixed or that the feature works as
+   expected.
+4. Send a pull request and bug the maintainer until it gets merged and published.