Skip to content

Creating docs using "make html" fails #10137

Description

@mhvk

I'm having trouble building the docs; using tox, it just fails more or less outright, for reasons that may have to do with the way Debian sets things up (will try to raise a separate issue), but even the nominal way using make html fails, with what at least seems to be something that would be easier to fix:

pip install .[docs]
cd docs
make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.8.5

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/sphinx/config.py", line 368, in eval_config_file
    execfile_(filename, namespace)
  File "/usr/lib/python3/dist-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "/home/mhvk/data/mhvk/packages/astropy/docs/conf.py", line 91, in <module>
    rst_epilog += """
AttributeError: module 'astropy' has no attribute '__minimum_scipy_version__'

If I replace the {0.__minimum_scipy_version__} in

.. |minimum_scipy_version| replace:: {0.__minimum_scipy_version__}
with some text, make html does work.

Activity

  1. pllim commented on Apr 10, 2020

    @pllim
    Member

    Your Sphinx is too old? I think it is 2.x now.

  2. bsipocz commented on Apr 10, 2020

    @bsipocz
    Member

    As I see we haven't yet bumped the required mininum version, it's still 1.7.

    However that's ancient, so I'm 💯 for bumping it if it solves this issue.

  3. mhvk commented on Apr 10, 2020

    @mhvk
    ContributorAuthor

    Debian/testing has sphinx 1.8.5, which was released 2019 March 10, so just a year ago. But I'll check whether that is in fact the problem...

  4. mhvk commented on Apr 10, 2020

    @mhvk
    ContributorAuthor

    Hmm, it is not a sphinx version thing, but somehow related to my Debian installation - things only do not work when I use --system-site-packages (it works fine with sphinx==1.8.5 in a clean venv). I have noticed this before and it is unfortunate, as it used to work fine, but clearly this is not directly an astropy issue, so I'll close.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions