Fix strange behavior in sphinx 6

.gitattributes

@@ -1,5 +1,9 @@
+/docs/*.py          export-ignore
+/docs/*.txt         export-ignore
+/docs/_*            export-ignore
 /sandbox            export-ignore
 /tests              export-ignore
 /.git*              export-ignore
 /*.yml              export-ignore
 /*.xml              export-ignore
+/*.xml.dist         export-ignore

.gitignore

@@ -1,5 +1,7 @@
 /.idea
 /reports
 /docs/build
+/docs/venv
 vendor
 composer.lock
+/.phpunit.result.cache

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: 'ubuntu-22.04'
+  tools:
+    python: '3.11'
+
+sphinx:
+  configuration: 'docs/conf.py'
+
+python:
+  install:
+  - requirements: 'docs/requirements.txt'

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 *Jun 7, 2022*
 
-* Shortcut config for `liceneses.allowed` and `packages.allowed` 
+* Shortcut config for `liceneses.allowed` and `packages.allowed`
 
 ## 1.0.1
 

README.md

@@ -6,6 +6,12 @@
 
 License management plugin for Composer.
 
+## Installation
+
+```sh 
+composer require 'arokettu/composer-license-manager'
+```
+
 ## Features
 
 The plugin is configured in the ``extras`` section of the ``composer.json`` file.
@@ -36,12 +42,6 @@ Run ``composer licenses:scan`` to check installed packages for undesired license
 
 With `"enforced": true` (default setting) the plugin will prevent installation of packages with undesired licenses during `composer install` and `composer update`. 
 
-## Installation
-
-```sh 
-composer require 'arokettu/composer-license-manager'
-```
-
 ## Documentation
 
 Read full documentation here: <https://sandfox.dev/php/composer-license-manager.html>
@@ -52,6 +52,8 @@ Also on Read the Docs: <https://composer-license-manager.readthedocs.io/>
 
 Please file issues on our main repo at GitLab: <https://gitlab.com/sandfox/composer-license-manager/-/issues>
 
+Feel free to ask any questions in our room on Gitter: <https://gitter.im/arokettu/community>
+
 ## License
 
 The library is available as open source under the terms of the [MIT License].

composer.json

@@ -54,7 +54,7 @@
     "require-dev": {
         "composer/composer": "^2.0",
         "phpunit/phpunit": "^7.5 || ^9.5",
-        "sandfox.dev/code-standard": "^10@dev",
+        "sandfox.dev/code-standard": "^1",
         "squizlabs/php_codesniffer": "*",
         "vimeo/psalm": "^4.23"
     }

docs/_templates/rtd-version.html

@@ -0,0 +1,3 @@
+{%- if current_version -%}
+    <div class="sidebar-brand">{{ current_version }}</div>
+{%- endif -%}

docs/_templates/sidebar/brand.html

@@ -1,22 +0,0 @@
-<a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}">
-    {% block brand_content %}
-    {%- if logo_url %}
-    <div class="sidebar-logo-container">
-        <img class="sidebar-logo" src="{{ logo_url }}" alt="Logo"/>
-    </div>
-    {%- endif %}
-    {%- if theme_light_logo and theme_dark_logo %}
-    <div class="sidebar-logo-container">
-        <img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" alt="Light Logo"/>
-        <img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" alt="Dark Logo"/>
-    </div>
-    {%- endif %}
-    {% if not theme_sidebar_hide_name %}
-    <span class="sidebar-brand-text">{{ docstitle if docstitle else project }}</span>
-    {%- endif %}
-    {% endblock brand_content %}
-</a>
-
-{%- if current_version -%}
-    <div class="sidebar-brand">{{ current_version }}</div>
-{%- endif -%}

docs/conf.py

@@ -1,6 +1,10 @@
 from datetime import datetime
 
-project = 'Composer License Manager'
+# import specific project config
+import os, sys
+sys.path.append(os.curdir)
+from conf_project import *
+
 author = 'Anton Smirnov'
 copyright = '{} {}'.format(datetime.now().year, author)
 language = 'en'
@@ -8,3 +12,15 @@ language = 'en'
 html_title = project
 html_theme = 'furo'
 templates_path = ["_templates"]
+html_sidebars = {
+    "**": [
+        "sidebar/brand.html",
+        "rtd-version.html",
+        "sidebar/search.html",
+        "sidebar/scroll-start.html",
+        "sidebar/navigation.html",
+        "sidebar/ethical-ads.html",
+        "sidebar/scroll-end.html",
+        "sidebar/variant-selector.html",
+    ]
+}

docs/conf_project.py

@@ -0,0 +1 @@
+project = 'Composer License Manager'

docs/requirements.txt

@@ -1 +1,2 @@
+sphinx>=7
 furo

phpunit.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.5/phpunit.xsd"
          convertDeprecationsToExceptions="true"
-         executionOrder="random">
+         executionOrder="random"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd">
     <testsuites>
         <testsuite name="all">
             <directory>tests</directory>