[NEW] Release v1.0.0 featuring new Documentation Pages

Author: boromir674

.circleci/config.yml

@@ -88,7 +88,7 @@ jobs:
           name: Upload the code coverage measurements to codecov.io, resulted from running the test suite (unit tests)
           command: ./.codecov
 
-  testpypi-install-n-test:
+  deploy-to-test-pypi:
     executor: py38-docker-image
     steps:
       - checkout
@@ -181,15 +181,15 @@ workflows:
       #           - master
       #           - dev
       #           - release-staging
-      - testpypi-install-n-test:
+      - deploy-to-test-pypi:
           requires:
             - build_n_test
           filters:
             branches:
               only: test-pypi
       - integration-test:
           requires:
-            - testpypi-install-n-test
+            - deploy-to-test-pypi
           filters:
             branches:
               only: test-pypi

CHANGELOG.rst

@@ -1,3 +1,34 @@
+Changelog
+=========
+
+
+1.0.0 (2022-01-10)
+------------------
+
+Changes
+^^^^^^^
+
+feature
+"""""""
+- include a developer guide in the documentation pages
+
+developer
+"""""""""
+- add docs tox commands to facilitate automatic docs build locally
+
+documentation
+"""""""""""""
+- add developer guide & redesign chapters, sections, etc
+- dedicate a section for the patterns implementation in the documentation pages
+- add landing page with logo
+
+ci
+""
+- configure sphinx to build the documentation files
+- use the readthedocs server to automatically build (generate html, pdf & epub files) and host the documentation pages
+
+
+
 0.9.0 (2021-12-09)
 ------------------
 

README.rst

@@ -9,8 +9,8 @@ A Python package with common Software Design Patterns.
 .. list-table::
     :stub-columns: 1
 
-    * - tests
-      - | |circleci| |codecov|
+    * - build
+      - | |circleci| |codecov| |docs|
 
     * - package
       - | |pypi| |wheel| |py_versions| |commits_since|
@@ -19,6 +19,13 @@ A Python package with common Software Design Patterns.
       - |better_code_hub| |codacy| |code_climate| |maintainability| |scrutinizer|
 
 
+|
+| **Documentation:** https://software-patterns.readthedocs.io/en/master
+| **Source Code:** https://github.com/boromir674/software-patterns
+| **CI/CD:** https://circleci.com/gh/boromir674/software-patterns/tree/master
+|
+
+
 
 Overview
 ========
@@ -55,9 +62,12 @@ Install from the Pypi server:
 .. |codecov| image:: https://codecov.io/gh/boromir674/software-patterns/branch/master/graph/badge.svg?token=3POTVNU0L4
     :alt: Codecov
     :target: https://app.codecov.io/gh/boromir674/software-patterns/branch/master
-    
 
 
+.. |docs| image:: https://img.shields.io/readthedocs/software-patterns/latest?logo=readthedocs
+    :target: https://software-patterns.readthedocs.io/en/latest/?badge=latest
+    :alt: Read the Docs (version)
+
 .. |pypi| image:: https://img.shields.io/pypi/v/software-patterns?color=blue&label=pypi&logo=pypi&logoColor=%23849ed9
     :alt: PyPI
     :target: https://pypi.org/project/software-patterns/
@@ -72,7 +82,7 @@ Install from the Pypi server:
 
 .. |commits_since| image:: https://img.shields.io/github/commits-since/boromir674/software-patterns/v0.9.0/master?color=blue&logo=Github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/software-patterns/compare/v0.9.0..master
+    :target: https://github.com/boromir674/software-patterns/compare/v1.0.0..master
 
 
 
@@ -95,13 +105,3 @@ Install from the Pypi server:
 .. |scrutinizer| image:: https://img.shields.io/scrutinizer/quality/g/boromir674/software-patterns/master?logo=scrutinizer-ci
     :alt: Scrutinizer code quality
     :target: https://scrutinizer-ci.com/g/boromir674/software-patterns/?branch=master
-
-
-
-.. |version| image:: https://img.shields.io/pypi/v/topic-modeling-toolkit.svg
-    :alt: PyPI Package latest release
-    :target: https://pypi.org/project/topic-modeling-toolkit
-
-.. |python_versions| image:: https://img.shields.io/pypi/pyversions/software-patterns.svg
-    :alt: Supported versions
-    :target: https://pypi.org/project/software-patterns/

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Konstantinos Lampridis'
 
 # The full version, including alpha/beta/rc tags
-release = '0.9.0'
+release = '1.0.0'
 
 # -- General configuration ---------------------------------------------------
 
@@ -73,13 +73,13 @@
 # provided by the sphinx.ext.extlinks extension
 
 # With the current settings (see the mapping below), you can for example use the directive :issue:`50`, which will
-# render a link with text 'issue 50' which upon clicking redirects to https://github.com/peterwittek/somoclu/issues/50
+# render a link with text 'issue 5' which upon clicking redirects to https://github.com/boromir674/software-patterns/issues/5
 
 # Mapping of link identifiers/keys to:
 # 2-length tuples with 1st item the url and 2nd the prefix (the "text string")
 # extlinks = {
 #     'issue': (
-#         'https://github.com/peterwittek/somoclu/issues/%s',
+#         'https://github.com/boromir674/software-patterns/issues/%s',
 #         'issue '
 #     ),
 # }

setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
 ## Setuptools specific information
 name = software_patterns
-version = 0.9.0
+version = 1.0.0
 description = Software Design Patterns with types in Python.
 long_description = file: README.rst
 long_description_content_type = text/x-rst
@@ -80,16 +80,20 @@ version_source=source
 
 [check-manifest]
 ignore =
+    CHANGELOG.rst
+    docs/*
+    docs/patterns-implementations/*
+    docs/static/*
     requirements/*
     scripts/*.py
     tox.ini
-    .circleci/config.yml
-    .travis.yml
     .bettercodehub.yml
-    .scrutinizer.yml
+    .circleci/config.yml
     .coveragerc
+    .DS_Store
     .gitignore
-    .pylintrc
     .prospector.yml
-    .DS_Store
-    CHANGELOG.rst
+    .pylintrc
+    .readthedocs.yml
+    .scrutinizer.yml
+    .travis.yml

src/software_patterns/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.9.0'
+__version__ = '1.0.0'
 
 from .notification import Observer, Subject
 from .memoize import ObjectsPool