hdmf-dev / hdmf-docutils

Collection of CLIs, scripts and modules useful to generate HDMF/NWB schema documentation
Other
0 stars 3 forks source link

Generated conf.py is broken #70

Closed rly closed 3 years ago

rly commented 3 years ago

The generated conf.py includes the following:

# -- Options for intersphinx extension ---------------------------------------

intersphinx_mapping = {
############################################################################
#  CUSTOM CONFIGURATIONS ADDED BY THE NWB TOOL FOR GENERATING FORMAT DOCS
###########################################################################

import sphinx_rtd_theme  # noqa: E402
import textwrap  # noqa: E402

# -- Options for intersphinx  ---------------------------------------------
intersphinx_mapping = {'core': ('https://nwb-schema.readthedocs.io/en/latest/', None)}

Note the syntax error at intersphinx_mapping = {. This is due to the (hacky) file cleaning in init_sphinx_extension_doc.py. It looks like much of this cleaning code can be removed and/or replaced.

This whole script should probably be cleaned up, but that is a separate, larger issue.