cookiecutter-science-project
cookiecutter-science-project copied to clipboard
Added fixes so that dummy docs build locally and on readthedocs. In n…
…o particular order, these include:
- recommonmark sphinx extension is deprecated, replace with myst_parser ((https://github.com/readthedocs/recommonmark/issues/221)
- fixed dummy module name in api.rst (dummy -> dummy_module) so that build does not fail
- fixed indenting, replaced '-' with '=', add '*' so that api.rst does not cause build to fail
- replaced emoji in title of notebook so that build does not fail (is this related to emoji encoding issue?)
- introduced hack in index.rst (mulitple '=' symbols) as build seems to fail if project name is greater than the default number of '='. With this hack, build will only fail if project name is > 50 characters long (unlikely...)
- added srclinks to conf.py to prevent build warning
- updated readthedocs.yml according to latest best practice on readthedocs site
- added instructions in README to install package prior to local build (otherwise build will fail)
- fixed layout of cookiecutter README so that docs badge displays correctly
- applied precommit default linting (end-of-file fixer etc)
- added _static and _template subdirectories so that build successful on readthedocs
Check out this pull request on
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
Hey. This pull request is so that the default docs will build locally and on readthedocs (as of August '21 on a machine with Ubuntu at least).
In my experience, it seems like there is always some small issue that will prevent the docs from building successfully. And dependencies seem to get updated regularly enough (and often can lead to docs failing to build again), that perhaps this pull request is a little pointless!
Let me know if you think it's helpful, and what further changes I should make if it is.