Revert "full feature" build

The default branch should make it easy to test things. There is a new branch called "full-feature" that has all the features enabled. This reverts commit a1c1d14.
readthedocs · Aug 14, 2024 · 781900b · 781900b
1 parent 185f27f
commit 781900b
Show file tree

Hide file tree

Showing 18 changed files with 29 additions and 319 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,34 +1,20 @@
 version: 2
 
 build:
-  os: ubuntu-24.04
+  os: ubuntu-22.04
   tools:
     python: "latest"
     nodejs: "latest"
-    golang: "latest"
-    rust: "latest"
-    ruby: "latest"
   apt_packages:
     - tree
-    - libasound2t64
   jobs:
     post_checkout:
      # Test we can use a PUBLIC environment variable in a command
-     - echo ${PUBLIC}
+     - set -x; test -n "${PUBLIC}"
 
     post_install:
       # Test jsdoc
-      - npm install -g jsdoc
-
-    pre_build:
-      - shot-scraper install
-      - shot-scraper https://datasette.io/ --height 800 -o docs/static/datasette.png
-
-    post_build:
-      # Download a PDF sample and expose it
-      - mkdir -p $READTHEDOCS_OUTPUT/pdf/
-      - wget https://pdfobject.com/pdf/sample.pdf -O $READTHEDOCS_OUTPUT/pdf/my-file.pdf
-
+      - npm install -g jsdoc  jobs:
 
 sphinx:
   configuration: docs/conf.py

diff --git a/docs/conf.py b/docs/conf.py
@@ -1,31 +1,18 @@
+# -*- coding: utf-8 -*-
+
 # Default settings
 project = 'Test Builds'
 extensions = [
     'sphinx_autorun',
     'notfound.extension',
     'hoverxref.extension',
     'sphinx_js',
-    'sphinx_tabs.tabs',
-    'sphinx_jinja2',
 ]
 
 latex_engine = 'xelatex'  # allow us to build Unicode chars
-
-autosectionlabel_prefix_document = True
 hoverxref_auto_ref = True
-hoverxref_roles = [
-    'term',
-]
 
 # Include all your settings here
 html_theme = 'sphinx_rtd_theme'
 
 js_source_path = '../src/'
-html_extra_path = ['static']
-html_context = {
-    "comment": "This comment is injected manually as a test.",
-}
-
-jinja2_env_kwargs = {
-    "extensions": ["jinja2.ext.loopcontrols"],
-}
diff --git a/docs/conf.py.rst b/docs/conf.py.rst
diff --git a/docs/conf.rst b/docs/conf.rst
@@ -0,0 +1,6 @@
+conf.py
+=======
+
+.. literalinclude:: conf.py
+   :language: python
+   :linenos:
diff --git a/docs/glossary.rst b/docs/glossary.rst
diff --git a/docs/hoverxref.rst b/docs/hoverxref.rst
@@ -1,26 +1,4 @@
 sphinx-hoverxref
 ================
 
-Make usage of ``sphinx-hoverxref`` and test different scenarios.
-
-Tooltips with issues on glossary
---------------------------------
-
-* Issue: https://github.com/readthedocs/sphinx-hoverxref/issues/97
-
-Example:
-
-* :term:`term 1`
-* :term:`term 2`
-
-
-Reference to a title
---------------------
-
-:ref:`conf.py:conf.py`
-
-
-Reference to a document
-------------------------
-
-:doc:`conf.py`
+Link to a page you can hover: :ref:`index`.
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,18 +5,26 @@ GitHub repository to test different Read the Docs builds scenarios.
 
 .. toctree::
 
-   latest-aliases
    hoverxref
    environment-variables
    jsdoc
-   tabs
-   notfound-page
-   robots
-   pygments
-   shot-scraper
-   conf.py
-   readthedocs.yaml
-   sphinx-context
+
+----
+
+Read the Docs configuration file used to build this docs:
+
+.. literalinclude:: ../.readthedocs.yaml
+   :language: yaml
+   :linenos:
+
+----
+
+Sphinx configuration file used to build this docs (:doc:`see full file <conf>`),
+
+.. literalinclude:: conf.py
+   :language: python
+   :end-before: ###########################################################################
+   :linenos:
 
 ----
 

diff --git a/docs/latest-aliases.rst b/docs/latest-aliases.rst
diff --git a/docs/notfound-page.rst b/docs/notfound-page.rst
diff --git a/docs/pygments.rst b/docs/pygments.rst
diff --git a/docs/readthedocs.yaml.rst b/docs/readthedocs.yaml.rst
diff --git a/docs/robots.rst b/docs/robots.rst
diff --git a/docs/shot-scraper.rst b/docs/shot-scraper.rst
diff --git a/docs/sphinx-context.rst b/docs/sphinx-context.rst
diff --git a/docs/static/robots.txt b/docs/static/robots.txt
diff --git a/docs/tabs.rst b/docs/tabs.rst
diff --git a/requirements.txt b/requirements.txt
@@ -1,14 +1,9 @@
 sphinx-autorun
-sphinx-jinja2
 sphinx-rtd-theme
 sphinx-notfound-page
 sphinx-hoverxref
-sphinx-tabs
-shot-scraper
 
 sphinx-js
 # Pin it because it fails otherwise
 # ImportError: cannot import name 'soft_unicode' from 'markupsafe'
 markupsafe==2.0.1
-
-git+https://github.com/shawalli/pygments-lexer-apex.git#egg=pygments-lexer-apex