Merge pull request #12 from /issues/9-add_better_logging

Added better documentation about troubleshooting broken links
ColinKennedy · Mar 16, 2024 · be20e6c · be20e6c
2 parents d1d27ac + 73407d9
commit be20e6c
Show file tree

Hide file tree

Showing 37 changed files with 372 additions and 370 deletions.
diff --git a/.codacy.yaml b/.codacy.yaml
@@ -1,5 +1,5 @@
 ---
 exclude_paths:
-    - ci/**/*
-    - tests/unittests/fake_project/**
+    - docs/conf.py
     - fake_project/**
+    - tests/unittests/fake_project/**
diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml
@@ -0,0 +1,11 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: "11:00"
+  groups:
+    python-packages:
+      patterns:
+        - "*"
diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml
@@ -93,7 +93,7 @@ jobs:
         --repo '${{ github.repository }}'
 
   publish-to-testpypi:
-    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    name: Publish to TestPyPI
     needs:
     - build
     runs-on: ubuntu-latest
@@ -111,7 +111,7 @@ jobs:
       with:
         name: python-package-distributions
         path: dist/
-    - name: Publish distribution 📦 to TestPyPI
+    - name: Publish to TestPyPI
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
         repository-url: https://test.pypi.org/legacy/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,14 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+#
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+sphinx:
+  configuration: docs/conf.py
+python:  # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+  install:
+    - requirements: requirements.txt
+    - requirements: docs/requirements.txt
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,12 @@
 Changelog
 =========
 
+1.4.0 (2024-03-16)
+------------------
+
+* Added better CI, updated GitHub badges, various quality of life changes
+
+
 1.3.0 (2024-03-14)
 ------------------
 

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -49,7 +49,7 @@ To set up `sphinx-code-include` for local development:
 
    Now you can make your changes locally.
 
-4. When you're done making changes run all the checks and docs builder with `tox <https://tox.readthedocs.io/en/latest/install.html>`_ one command::
+4. When you're done making changes run all the checks and docs builder with `tox <https://tox.wiki/en/latest/installation.html>`_ one command::
 
     tox
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -19,6 +19,7 @@ exclude .cookiecutterrc
 exclude .coveragerc
 exclude .editorconfig
 exclude .pylintrc
+exclude .readthedocs.yaml
 exclude .travis.yml
 exclude tox.ini
 

diff --git a/README.rst b/README.rst
@@ -10,36 +10,34 @@ Overview
     * - docs
       - |docs|
     * - tests
-      - | |travis| |appveyor| |requires|
+      - | |dependabot|
         | |codecov|
         | |codacy|
     * - package
-      - | |version| |wheel| |supported-versions| |supported-implementations|
+      - | |version| |wheel| |oses| |supported-versions| |supported-implementations|
         | |commits-since|
-.. |docs| image:: https://readthedocs.org/projects/sphinx-code-include/badge/?style=flat
-    :target: https://readthedocs.org/projects/sphinx-code-include
-    :alt: Documentation Status
 
-.. |travis| image:: https://api.travis-ci.org/ColinKennedy/sphinx-code-include.svg?branch=master
-    :alt: Travis-CI Build Status
-    :target: https://travis-ci.org/ColinKennedy/sphinx-code-include
 
-.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/ColinKennedy/sphinx-code-include?branch=master&svg=true
-    :alt: AppVeyor Build Status
-    :target: https://ci.appveyor.com/project/ColinKennedy/sphinx-code-include
+.. |dependabot| image:: https://img.shields.io/badge/dependabot-025E8C?style=for-the-badge&logo=dependabot&logoColor=white
+    :target: https://img.shields.io/badge/dependabot-025E8C?style=for-the-badge&logo=dependabot&logoColor=white
+    :alt: Dependencies Auto-Checks are enabled
 
-.. |requires| image:: https://requires.io/github/ColinKennedy/sphinx-code-include/requirements.svg?branch=master
-    :alt: Requirements Status
-    :target: https://requires.io/github/ColinKennedy/sphinx-code-include/requirements/?branch=master
+.. |docs| image:: https://readthedocs.org/projects/sphinx-code-include/badge/?style=flat
+    :target: https://readthedocs.org/projects/sphinx-code-include
+    :alt: Documentation Status
 
 .. |codecov| image:: https://codecov.io/github/ColinKennedy/sphinx-code-include/coverage.svg?branch=master
     :alt: Coverage Status
     :target: https://codecov.io/github/ColinKennedy/sphinx-code-include
 
-.. |codacy| image:: https://api.codacy.com/project/badge/Grade/cd0e702ea8f744088d93c4addd3deeea
-    :target: https://www.codacy.com/manual/ColinKennedy/sphinx-code-include?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=ColinKennedy/sphinx-code-include&amp;utm_campaign=Badge_Grade
+.. |codacy| image:: https://app.codacy.com/project/badge/Grade/0ea5a564f6fe4f79bd956863943add4b
+    :target: https://app.codacy.com/gh/ColinKennedy/sphinx-code-include/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
     :alt: Codacy Code Quality Status
 
+.. |oses| image:: https://img.shields.io/badge/os-linux%20%7C%20macOS%20%7C%20windows-blue
+    :alt: Supported OSes
+    :target: https://img.shields.io/badge/os-linux%20%7C%20macOS%20%7C%20windows-blue
+
 .. |version| image:: https://img.shields.io/pypi/v/sphinx-code-include.svg
     :alt: PyPI Package latest release
     :target: https://pypi.org/project/sphinx-code-include
@@ -56,9 +54,9 @@ Overview
     :alt: Supported implementations
     :target: https://pypi.org/project/sphinx-code-include
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/ColinKennedy/sphinx-code-include/v1.3.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/ColinKennedy/sphinx-code-include/v1.4.0.svg
     :alt: Commits since latest release
-    :target: https://github.com/ColinKennedy/sphinx-code-include/compare/v1.3.0...master
+    :target: https://github.com/ColinKennedy/sphinx-code-include/compare/v1.4.0...master
 
 
 

diff --git a/ci/appveyor-with-compiler.cmd b/ci/appveyor-with-compiler.cmd
diff --git a/ci/bootstrap.py b/ci/bootstrap.py
diff --git a/ci/requirements.txt b/ci/requirements.txt
diff --git a/ci/templates/.appveyor.yml b/ci/templates/.appveyor.yml
diff --git a/ci/templates/.travis.yml b/ci/templates/.travis.yml
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,7 @@
 year = '2019'
 author = u'Colin Kennedy'
 copyright = '{0}, {1}'.format(year, author)
-version = release = u'1.3.0'
+version = release = u'1.4.0'
 
 pygments_style = 'trac'
 templates_path = ['.']
@@ -55,17 +55,12 @@
 import os
 import sys
 
-sys.path.append(os.path.dirname(os.path.abspath(__file__)))
+root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+sys.path.append(os.path.join(root, "src"))
 
-# Add `code-include` so that the code-include directives used in this documentation work
-extensions += [
-    "code_include.extension",
-]
+extensions += ["code_include.extension", "sphinx.ext.intersphinx", "sphinx_rtd_theme"]
 
-# These next settings are required if you want to link to other Sphinx projects
-extensions += [
-    "sphinx.ext.intersphinx",
-]
+html_theme = "sphinx_rtd_theme"
 
 intersphinx_mapping = {
     "https://requests.kennethreitz.org/en/latest": None,