Skip to content

8.3.0: sphinx warnings reference target not found #711

@kloczek

Description

@kloczek

First of all it is not possible now use straight sphinx-build

[tkloczko@devel-g2v ipyparallel-8.3.0]$ /usr/bin/sphinx-build -n -T -b html docs/source build/sphinx/html
Running Sphinx v4.5.0
WARNING: The config value `today' has type `date', defaults to `str'.
loading pickled environment... done
[autosummary] generating autosummary for: api/ipyparallel.rst, changelog.md, examples/Cluster API.ipynb, examples/Data Publication API.ipynb, examples/Futures.ipynb, examples/Index.ipynb, examples/Monitoring an MPI Simulation - 1.ipynb, examples/Monitoring an MPI Simulation - 2.ipynb, examples/Monte Carlo Options.ipynb, examples/Parallel Decorator and map.ipynb, ..., reference/mpi.md, reference/security.md, tutorial/asyncresult.md, tutorial/demos.md, tutorial/direct.md, tutorial/index.md, tutorial/intro.md, tutorial/magics.md, tutorial/process.md, tutorial/task.md
Failed to import ipyparallel.cluster.launcher.
Possible hints:
* KeyError: 'ipyparallel'
* ModuleNotFoundError: No module named 'ipyparallel'
myst v0.17.2: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=['colon_fence', 'deflist'], linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, highlight_code_blocks=True, number_code_blocks=[], title_to_header=False, heading_anchors=None, heading_slug_func=None, footnote_transition=True, sub_delimiters=('{', '}'), words_per_minute=200)
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
no targets are out of date.
build succeeded, 2 warnings.

This can be fixed using patch like below

--- a/docs/source/conf.py~      2022-05-14 17:50:07.000000000 +0000
+++ b/docs/source/conf.py       2022-05-14 17:52:22.860215430 +0000
@@ -16,7 +16,10 @@
 # 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.insert(0, os.path.abspath('.'))
+import sys
+import os
+sys.path.insert(0, os.path.abspath('../..'))
+
 # We load the ipython release info into a dict by explicit execution
 iprelease = {}
 exec(

Than .. on building my packages I'm using sphinx-build command with -n switch which shows warmings about missing references. These are not critical issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions