Documentation config

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#     - requirements: docs/requirements.txt

docs/conf.py

@@ -24,13 +24,13 @@
 # -- Project information -----------------------------------------------------
 
 project = "DMP - Free Music Publishing Catalogue"
-copyright = "2018-2023, Matija Kolarić"
+copyright = "2018-2024, Matija Kolarić"
 author = "Matija Kolarić"
 
 # The short X.Y version
-version = "23.4 Rubicon"
+version = "24.7 Holiday"
 # The full version, including alpha/beta/rc tags
-release = "23.4"
+release = "24.7"
 
 rst_epilog = """
 .. |version| replace:: {}
@@ -57,7 +57,7 @@
     "sphinxcontrib.mermaid",
 ]
 
-mermaid_version = "9.4.2"
+mermaid_version = "10.9.1"
 
 autodoc_member_order = "bysource"
 

music_publisher/templates/admin/base.html

@@ -38,11 +38,11 @@
     html[data-theme="dark"] {
         --primary: #a31212;
         --secondary: var(--primary);
-        --link-fg: var(--primary);
+        --link-fg: #ff2222;
         --header-bg: var(--body-bg);
         --header-color: var(--body-fg);
         --header-link-color: var(--primary);
-        --accent: var(--primary);
+        --accent: #ff2222;
         --link-selected-fg: var(--link-fg);
         --link-hover-color: var(--body-fg);
         --object-tools-bg: var(--primary);
@@ -140,7 +140,7 @@
 
     {% if not is_popup %}
         <div>
-            <a href="https://dmp.matijakolaric.com"><img src="{% static 'android-chrome-192x192.png' %}" alt="DMP" class="logo"></a>
+            <a href="https://django-music-publisher.readthedocs.io/" target="_blank"><img src="{% static 'android-chrome-192x192.png' %}" alt="DMP" class="logo"></a>
             <!-- Header -->
             {% block header %}
             <div id="header">
@@ -150,11 +150,12 @@
                 {% block usertools %}
                 {% if has_permission %}
                 <div id="user-tools">
-                    {% block welcome-msg %}
-                        {% translate 'Welcome,' %}
-                        <strong>{% firstof user.get_short_name user.get_username %}</strong>.
-                    {% endblock %}
                     {% block userlinks %}
+                        {% if opts.app_label == 'music_publisher' %}
+                            <a href="https://django-music-publisher.readthedocs.io/en/latest/manual_{{ opts.model_name }}.html" target="_blank">User Manual</a> /
+                        {% else %}
+                            <a href="https://django-music-publisher.readthedocs.io/en/latest/manual.html" target="_blank">User Manual</a> /
+                        {% endif %}
                         {% if site_url %}
                             <a href="{{ site_url }}">{% translate 'View site' %}</a> /
                         {% endif %}