Skip to content

Cannot build docs from current master #10026

New issue
New issue
Closed
Closed
Cannot build docs from current master#10026
Assignees
bsipocz
Labels
Docszzz 💤 astropy-helpers-removalarchived: PRs and issues related to the removal of astropy-helpers

Description

@taldcroft
taldcroft
opened on Mar 10, 2020

Description

Cannot build docs from current master.

Expected behavior

tox -e build_docs should build the documentation.

Actual behavior

I got instead the error below and no output docs/_build/html/index.html file.

...
reading sources... [ 99%] whatsnew/4.1
reading sources... [100%] whatsnew/index


Warning, treated as error:
/Users/aldcroft/git/astropy/docs/units/index.rst.rst:402:autosummary: stub file not found 'astropy.units.function.logarithmic.m_bol'. Check your autosummary_generate setting.
ERROR: InvocationError for command /Users/aldcroft/git/astropy/.tox/build_docs/bin/sphinx-build -W -b html . _build/html (exited with code 2)
___________________________________________________________________________ summary ____________________________________________________________________________
ERROR:   build_docs: commands failed

Steps to Reproduce

git checkout master
git pull upstream master
git clean -fxd
rm -rf .tox/build_docs
tox -e build_docs

# Put your Python code snippet here.

System Details

Darwin-19.2.0-x86_64-i386-64bit
Python 3.6.10 |Anaconda, Inc.| (default, Jan  7 2020, 15:01:53) 
[GCC 4.2.1 Compatible Clang 4.0.1 (tags/RELEASE_401/final)]
Numpy 1.18.1
astropy 4.1.dev737+gade7e2492
Scipy 1.4.1

Activity

  1. taldcroft
    added
    Docs
    on Mar 10, 2020

  2. pllim commented on Mar 10, 2020

    @pllim
    pllim
    on Mar 10, 2020
    Member

    Does a plain make html work?

  3. pllim
    added
    zzz 💤 astropy-helpers-removalarchived: PRs and issues related to the removal of astropy-helpers
    on Mar 10, 2020

  4. saimn commented on Mar 10, 2020

    @saimn
    saimn
    on Mar 10, 2020
    Contributor

    The issue with m_bol is not new, e.g. #9040: m_bol and M_bol are conflicting on case-insensitive file systems, e.g. MacOS... And I guess tox is adding the option to treat warnings as error with Sphinx.

  5. pllim commented on Mar 10, 2020

    @pllim
    pllim
    on Mar 10, 2020
    Member

    I got several of these warnings when I run it inside a conda env:

    WARNING: Discarding $PYTHONPATH from environment, to override specify PYTHONPATH in 'passenv' in your configuration.

    But other than that, docs built fine on Linux, so it is consistent with what @saimn said. I knew that astropy.units.function.logarithmic.m_bol looked familiar.

    I vaguely some discussion between @bsipocz and @astrofrog about treating the warnings as errors recently.

  6. taldcroft commented on Mar 10, 2020

    @taldcroft
    taldcroft
    on Mar 10, 2020
    MemberAuthor

    I don't think that ever in my life have I built astropy docs without getting warnings...

  7. taldcroft commented on Mar 10, 2020

    @taldcroft
    taldcroft
    on Mar 10, 2020
    MemberAuthor

    make html does complete successfully, with the same warning that would turn into an error in tox. I think that tox -e build_docs should likewise complete and give a result even with errors. E.g. sometimes it is easier to understand a sphinx warning or error by looking at the output. One might add something like tox -e build_docs_strict to be strict.

    /Users/aldcroft/git/astropy/docs/units/index.rst.rst:402: WARNING: autosummary: stub file not found 'astropy.units.function.logarithmic.m_bol'. Check your autosummary_generate setting.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
[changelog_links] Adding changelog links to "changelog"                                                                                                                                                  
[changelog_links] Adding changelog links to "whatsnew/0.1"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/0.2"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/0.3"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/0.4"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/1.0"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/1.1"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/1.2"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/1.3"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/2.0"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/3.0"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/3.1"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/3.2"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/4.0"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/4.1"                                                                                                                                               
[changelog_links] Adding changelog links to "whatsnew/index"                                                                                                                                             

WARNING: dot code 'digraph inheritancead6d126c6f {\nrankdir=LR;\nsize="8.0, 12.0";\n  "AstropyWarning" [URL="../../api/astropy.utils.exceptions.AstropyWarning.html#astropy.utils.exceptions.AstropyWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="The base warning class from which all Astropy warnings should inherit."];\n  "ConfigItem" [URL="../../api/astropy.config.ConfigItem.html#astropy.config.ConfigItem",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A setting and associated value stored in a configuration file."];\n  "ConfigNamespace" [URL="../../api/astropy.config.ConfigNamespace.html#astropy.config.ConfigNamespace",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A namespace of configuration items.  Each subpackage with"];\n  "ConfigurationMissingWarning" [URL="../../api/astropy.config.ConfigurationMissingWarning.html#astropy.config.ConfigurationMissingWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A Warning that is issued when the configuration directory cannot be"];\n  "AstropyWarning" -> "ConfigurationMissingWarning" [arrowsize=0.5,style="setlinewidth(0.5)"];\n  "InvalidConfigurationItemWarning" [URL="../../api/astropy.config.InvalidConfigurationItemWarning.html#astropy.config.InvalidConfigurationItemWarning",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="A Warning that is issued when the configuration value specified in the"];\n  "AstropyWarning" -> "InvalidConfigurationItemWarning" [arrowsize=0.5,style="setlinewidth(0.5)"];\n  "_SetTempPath" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)"];\n  "set_temp_cache" [URL="../../api/astropy.config.set_temp_cache.html#astropy.config.set_temp_cache",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Context manager to set a temporary path for the Astropy download cache,"];\n  "_SetTempPath" -> "set_temp_cache" [arrowsize=0.5,style="setlinewidth(0.5)"];\n  "set_temp_config" [URL="../../api/astropy.config.set_temp_config.html#astropy.config.set_temp_config",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5)",target="_top",tooltip="Context manager to set a temporary path for the Astropy config, primarily"];\n  "_SetTempPath" -> "set_temp_config" [arrowsize=0.5,style="setlinewidth(0.5)"];\n}\n': dot exited with error:
[stderr]
b''
[stdout]
b''

  ** LOTS MORE LIKE THAT **


generating indices...  genindex py-modindexdone
highlighting module code... [100%] numpy.ma.core                                                                                                                                                         
writing additional pages...  searchdone
copying images... [100%] wcs/../_build/plot_directive/wcs/index-1.png                                                                                                                                    
copying downloadable files... [100%] timeseries/binned.csv                                                                                                                                               
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 13 warnings.

The HTML pages are in _build/html.

Sphinx-gallery successfully executed 0 out of 0 files subselected by:

    gallery_conf["filename_pattern"] = '^((?!skip_).)*$'
    gallery_conf["ignore_pattern"]   = '__init__\\.py'

after excluding 9 files that had previously been run (based on MD5).

embedding documentation hyperlinks...
embedding documentation hyperlinks for generated/examples... [100%] fits-tables.html                                                                                                                     

Build finished. The HTML pages are in _build/html.

  8. taldcroft commented on Mar 10, 2020

    @taldcroft
    taldcroft
    on Mar 10, 2020
    MemberAuthor

    Another nit is that I get this:

    (astropy) ➜  astropy git:(master) ✗ pip install -e .[docs]  
zsh: no matches found: .[docs]

    It needs to be pip install -e '.[docs]', at least on zsh.

  9. bsipocz commented on Mar 10, 2020

    @bsipocz
    bsipocz
    on Mar 10, 2020
    Member

    @pllim - Yes, we indeed talked about the exact same problem, but haven't yet followed up with a PR. I'll try to remember to make one later today.

  10. bsipocz
    self-assigned this
    on Mar 10, 2020

  11. pllim commented on Mar 10, 2020

    @pllim
    pllim
    on Mar 10, 2020
    Member

    Re: zsh -- Maybe add a note to dev docs about it?

  12. pllim commented on Jul 22, 2021

    @pllim
    pllim
    on Jul 22, 2021
    Member

    Well, docs have been building since, but if there is an actionable item to follow up on, please open new issue. Thanks!

  13. pllim
    closed this as completedon Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Docszzz 💤 astropy-helpers-removalarchived: PRs and issues related to the removal of astropy-helpers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions