jbusecke / cookiecutter-science-project

Cookiecutter template for science analysis projects
MIT License
86 stars 13 forks source link

Added fixes so that dummy docs build locally and on readthedocs. In n… #49

Closed nenb closed 2 years ago

nenb commented 3 years ago

…o particular order, these include:

1) recommonmark sphinx extension is deprecated, replace with myst_parser ((https://github.com/readthedocs/recommonmark/issues/221) 2) fixed dummy module name in api.rst (dummy -> dummy_module) so that build does not fail 3) fixed indenting, replaced '-' with '=', add '*' so that api.rst does not cause build to fail 4) replaced emoji in title of notebook so that build does not fail (is this related to emoji encoding issue?) 5) 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...) 6) added srclinks to conf.py to prevent build warning 7) updated readthedocs.yml according to latest best practice on readthedocs site 8) added instructions in README to install package prior to local build (otherwise build will fail) 9) fixed layout of cookiecutter README so that docs badge displays correctly 10) applied precommit default linting (end-of-file fixer etc) 11) added _static and _template subdirectories so that build successful on readthedocs

review-notebook-app[bot] commented 3 years ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

nenb commented 3 years ago

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.