0.4.1 release

pleiszenburg · Sep 11, 2022 · 9eb36bf · 9eb36bf
2 parents 70e8567 + 275d0d9
commit 9eb36bf
Show file tree

Hide file tree

Showing 26 changed files with 44 additions and 17 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,10 @@
 # Changes
 
+## 0.4.1 (2022-09-11)
+
+- DEV: Cleanup of `docs` folder structure.
+- DEV: Include logo in repo.
+
 ## 0.4.0 (2022-09-09)
 
 - FEATURE: Dropped support for Python 3.6.

diff --git a/HOWTORELEASE.md b/HOWTORELEASE.md
@@ -11,7 +11,6 @@
 1) Tag branch `master` with `f"v{version:s}"`: `git tag "v0.0.1"`
 1) Push the tag to Github: `git push origin --tags`
 1) Build and sign packages: `make release`
-1) Upload package to `pypitest` and review result: `make upload_test`
 1) Upload package to `pypi`: `make upload`
 1) Change to branch `develop`: `git checkout develop`
 1) In branch `develop`, bump the package version in `src/wenv/__init__.py` by changing the `__version__` string.

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![wenv](http://www.pleiszenburg.de/wenv_logo.png)
+![wenv](docs/source/_static/logo.png "wenv logo")
 
 # wenv - Running Python on Wine
 
@@ -68,7 +68,7 @@ See section on [Bugs and Issues](https://wenv.readthedocs.io/en/stable/bugs.html
 
 - Full project documentation
     - at [Read the Docs](https://wenv.readthedocs.io/en/latest/)
-    - at [`wenv` repository](https://github.com/pleiszenburg/wenv/blob/master/docs/index.rst)
+    - at [`wenv` repository](https://github.com/pleiszenburg/wenv/blob/master/docs/source/index.rst)
 - [Authors](https://github.com/pleiszenburg/wenv/blob/master/AUTHORS.md)
 - [Change log (current)](https://github.com/pleiszenburg/wenv/blob/develop/CHANGES.md) (changes in development branch since last release)
 - [Change log (past)](https://github.com/pleiszenburg/wenv/blob/master/CHANGES.md) (release history)

diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,7 @@
 #
 #	docs/makefile: GNU makefile for building the documentation
 #
-# 	Copyright (C) 2017-2020 Sebastian M. Ernst <[email protected]>
+# 	Copyright (C) 2017-2022 Sebastian M. Ernst <[email protected]>
 #
 # <LICENSE_BLOCK>
 # The contents of this file are subject to the GNU Lesser General Public License
@@ -23,8 +23,8 @@
 SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = wenv
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/changes.md b/docs/changes.md
diff --git a/docs/source/__init__.py b/docs/source/__init__.py
@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+"""
+WENV
+Running Python on Wine
+https://github.com/pleiszenburg/wenv
+
+    docs/source/__init__.py: Docs source root
+
+    Copyright (C) 2017-2022 Sebastian M. Ernst <[email protected]>
+
+<LICENSE_BLOCK>
+The contents of this file are subject to the GNU Lesser General Public License
+Version 2.1 ("LGPL" or "License"). You may not use this file except in
+compliance with the License. You may obtain a copy of the License at
+https://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt
+https://github.com/pleiszenburg/wenv/blob/master/LICENSE
+
+Software distributed under the License is distributed on an "AS IS" basis,
+WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
+specific language governing rights and limitations under the License.
+</LICENSE_BLOCK>
+"""
diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png
diff --git a/docs/_templates/layout.html → docs/source/_templates/layout.html b/docs/_templates/layout.html → docs/source/_templates/layout.html
diff --git a/docs/api.rst → docs/source/api.rst b/docs/api.rst → docs/source/api.rst
diff --git a/docs/bugs.rst → docs/source/bugs.rst b/docs/bugs.rst → docs/source/bugs.rst
diff --git a/docs/source/changes.md b/docs/source/changes.md
@@ -0,0 +1 @@
+../../CHANGES.md
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -6,7 +6,7 @@
 Running Python on Wine
 https://github.com/pleiszenburg/wenv
 
-    docs/conf.py: Configures the documentation build process
+    docs/source/conf.py: Configures the documentation build process
 
     Copyright (C) 2017-2022 Sebastian M. Ernst <[email protected]>
 
@@ -34,9 +34,9 @@
 import sys
 
 # sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..')))
 
-from docs.version import get_version
+from docs.source.version import get_version
 
 # -- General configuration ------------------------------------------------
 
@@ -124,14 +124,14 @@
         ('<i class="fa fa-envelope fa-fw"></i> Mailing List', 'https://groups.io/g/zugbruecke-dev'),
         ('<i class="fa fa-comments fa-fw"></i> Chat', 'https://matrix.to/#/#zugbruecke:matrix.org'),
         # ('<i class="fa fa-file-text fa-fw"></i> Citation', 'https://doi.org/000'),
-        ('<i class="fa fa-info-circle fa-fw"></i> pleiszenburg.de', 'http://www.pleiszenburg.de/'),
+        ('<i class="fa fa-info-circle fa-fw"></i> pleiszenburg.de', 'https://www.pleiszenburg.de/'),
     ],
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ["_static"]
+html_static_path = ["_static"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

diff --git a/docs/configuration.rst → docs/source/configuration.rst b/docs/configuration.rst → docs/source/configuration.rst
diff --git a/docs/env.rst → docs/source/env.rst b/docs/env.rst → docs/source/env.rst
diff --git a/docs/envconfig.rst → docs/source/envconfig.rst b/docs/envconfig.rst → docs/source/envconfig.rst
diff --git a/docs/examples.rst → docs/source/examples.rst b/docs/examples.rst → docs/source/examples.rst
diff --git a/docs/faq.rst → docs/source/faq.rst b/docs/faq.rst → docs/source/faq.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
@@ -1,6 +1,6 @@
 :github_url:
 
-.. image:: http://www.pleiszenburg.de/wenv_logo.png
+.. image:: _static/logo.png
 	:alt: wenv
 
 wenv - Running Python on Wine

diff --git a/docs/installation.rst → docs/source/installation.rst b/docs/installation.rst → docs/source/installation.rst
diff --git a/docs/introduction.rst → docs/source/introduction.rst b/docs/introduction.rst → docs/source/introduction.rst
diff --git a/docs/pythonversion.rst → docs/source/pythonversion.rst b/docs/pythonversion.rst → docs/source/pythonversion.rst
diff --git a/docs/security.rst → docs/source/security.rst b/docs/security.rst → docs/source/security.rst
diff --git a/docs/support.rst → docs/source/support.rst b/docs/support.rst → docs/source/support.rst
@@ -33,4 +33,4 @@ Paid Support
 
 In addition to the previous options, paid support is available from `pleiszenburg.de - Independent Scientific Services`_.
 
-.. _pleiszenburg.de - Independent Scientific Services: http://www.pleiszenburg.de
+.. _pleiszenburg.de - Independent Scientific Services: https://www.pleiszenburg.de
diff --git a/docs/usage.rst → docs/source/usage.rst b/docs/usage.rst → docs/source/usage.rst
diff --git a/docs/version.py → docs/source/version.py b/docs/version.py → docs/source/version.py
@@ -5,7 +5,7 @@
 Running Python on Wine
 https://github.com/pleiszenburg/wenv
 
-    docs/version.py: Package version parser
+    docs/source/version.py: Package version parser
 
     Copyright (C) 2017-2022 Sebastian M. Ernst <[email protected]>
 
@@ -55,7 +55,7 @@ def parse_version(code: str) -> str:
 def get_version() -> str:
 
     path = os.path.join(
-        os.path.dirname(__file__), '..', SRC_DIR, "wenv", "__init__.py",
+        os.path.dirname(__file__), '..', '..', SRC_DIR, "wenv", "__init__.py",
         )
 
     with open(path, "r", encoding="utf-8") as f:

diff --git a/src/wenv/__init__.py b/src/wenv/__init__.py
@@ -26,7 +26,7 @@
 # IMPORT / EXPORT
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-__version__ = '0.4.0'  # Bump version HERE!
+__version__ = '0.4.1'  # Bump version HERE!
 
 from ._core.env import (
     cli,