Fix references resolving

.github/workflows/ci.yml

@@ -33,46 +33,66 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
-        pip install -r test/unit/requirements.txt
+        pip install -r test/requirements.txt
         pip install .
 
-    - name: Build Test
+    - name: Build Unit Tests
       run: |
-        cd test/must-build && make html SPHINXOPTS='-W'
+        cd test
+        find . -name '*.html' -exec rm {} \;
 
-    - name: Build Test with toc show_parents=hide
-      run: |
-        cd test/must-build && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=hide'
+        sed -i 's~, "log\.md"~~' conf.py
+        make html SPHINXOPTS='' 2>&1 | tee log.txt
+        git restore conf.py
 
-    - name: Build Test with toc show_parents=domain
-      run: |
-        cd test/must-build && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=domain'
-
-    - name: Build Test with toc show_parents=all
-      run: |
-        cd test/must-build && make html SPHINXOPTS='-W -D toc_object_entries_show_parents=all'
+        (cd _build/html && rm genindex.html index.html search.html php-modindex.html)
+        (cd _build/html && find . -name '*.html' -exec sh -c 'xmllint {} --xpath '"'"'//div[@role="main"]'"'"' | xmllint --format - > ../../{}' \;)
+        sed -i -r 's~.*/(test/)~\1~;t;d' log.txt
 
-    - name: Run Unit Testing
+    - name: Apply Coding Style
+      if: matrix.python == '3.11'
       run: |
-        cd test/unit
-        find . -name '*.html' -exec rm {} \;
-        make html SPHINXOPTS='-W'
-        (cd _build/html && find . -name '*.html' -exec sh -c 'xmllint {} --xpath '"'"'//div[@role="main"]'"'"' | xmllint --format - > ../../{}' \;)
-        rm genindex.html index.html search.html php-modindex.html
+        pip install black
+        python -m black .
 
-    - name: Diff Unit Outputs
+    - name: Diff Unit Tests Output and Coding Style
       run: |
-        cd test/unit
+        cd test
         rm -r _build
         git add . -N && git diff --exit-code
 
-    - name: Push Unit Changes
-      if: failure()
+    - name: Push Unit Tests Output
+      if: failure() && github.repository_owner != 'markstory' && matrix.python == '3.11'
       uses: stefanzweifel/git-auto-commit-action@v4
       with:
         branch: ${{ github.head_ref || github.ref_name }}.changes
+        create_branch: true
         push_options: '--force'
-        commit_message: Unit Changes
+        commit_message: Unit Tests Changes
         commit_user_name: Bot
         commit_user_email: [email protected]
         commit_author: Bot <[email protected]>
+
+    - name: Build Unit Tests with '-W' option
+      run: |
+        cd test
+        make html SPHINXOPTS='-W'
+
+        sed -i 's~, "log\.md"~~' conf.py
+        ! make html SPHINXOPTS='-W' || (echo 'Unexpected zero exit code'; false)
+        git restore conf.py
+
+    - name: Build Unit Tests with toc show_parents=hide
+      run: |
+        cd test
+        make html SPHINXOPTS='-W -D toc_object_entries_show_parents=hide'
+
+    - name: Build Unit Tests with toc show_parents=domain
+      run: |
+        cd test
+        make html SPHINXOPTS='-W -D toc_object_entries_show_parents=domain'
+
+    - name: Build Unit Tests with toc show_parents=all
+      run: |
+        cd test
+        make html SPHINXOPTS='-W -D toc_object_entries_show_parents=all'

.gitignore

@@ -1,8 +1,7 @@
 dist/
 build/
 doc/_build
-test/must-build/_build
-test/unit/_build
+test/_build
 *.pyc
 *.egg-info
 .DS_Store

README.rst

@@ -2,6 +2,7 @@ PHP Domain for Sphinx
 #####################
 
 :author: Mark Story <mark at mark-story.com>
+:author: Michael Voříšek
 
 About
 =====

doc/conf.py

@@ -1,210 +1,207 @@
-# -*- coding: utf-8 -*-
-#
-# sphinxcontrib-rubydomain-acceptancetest documentation build configuration file, created by
-# sphinx-quickstart on Sun Apr 25 13:27:18 2010.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
 import sys, os
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath('..'))
+sys.path.append(os.path.abspath(".."))
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.0'
+needs_sphinx = "1.0"
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinxcontrib.phpdomain']
+extensions = ["sphinxcontrib.phpdomain"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'sphinxcontrib-phpdomain'
-copyright = u'2011, Mark Story'
+project = "sphinxcontrib-phpdomain"
+copyright = "2011 - 2023, Mark Story and Michael Voříšek"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = "0.1"
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = "0.1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'sphinxdoc'
+html_theme = "sphinxdoc"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # 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']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'sphinxcontrib-phpdomain'
+htmlhelp_basename = "sphinxcontrib-phpdomain"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'sphinxcontrib-phpdomain.tex', u'sphinxcontrib-phpdomain Documentation',
-   u'Mark Story', 'manual'),
+    (
+        "index",
+        "sphinxcontrib-phpdomain.tex",
+        "sphinxcontrib-phpdomain Documentation",
+        "Mark Story and Michael Voříšek",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'sphinxcontrib-phpdomain', u'sphinxcontrib-phpdomain Documentation',
-     [u'Mark Story'], 1)
+    (
+        "index",
+        "sphinxcontrib-phpdomain",
+        "sphinxcontrib-phpdomain Documentation",
+        ["Mark Story and Michael Voříšek"],
+        1,
+    )
 ]