neuroinformatics-unit / python-cookiecutter

Utility to create a basic Python project structure with tests, CI etc.
BSD 3-Clause "New" or "Revised" License
22 stars 3 forks source link

sphinx cannot find extension `sphinx-sitemap` #98

Closed ablot closed 8 months ago

ablot commented 8 months ago

Describe the bug A clear and concise description of what the bug is. If possible, please submit a Minimal Reproducible Example.

After default install, running sphinx-build docs/source docs/build fails because it cannot load sphinx-sitemap. This was solved by replacing the dash by an underscore in docs/source/conf.py in my local project. I assume the fix in the cookiecutter would be the same: https://github.com/znamlab/python-cookiecutter/commit/56fee90c797a01c252c4f3834a47427eec7a00d4

To Reproduce Please enter full details of how to reproduce this bug.

Create a new project and follow the ReadMe.md:

# Install the documentation build dependencies
pip install -r docs/requirements.txt
# Build the documentation
sphinx-build docs/source docs/build

or push anything to github (and the action will fail)

Expected behaviour A clear and concise description of what you expected to happen.

It should run and generate doc

Log file Please attach the log file if relevant.

Screenshots If applicable, add screenshots to help explain your problem.

Forgot to take one

Computer used (please complete the following information):

Additional context Add any other context about the problem here.

niksirbi commented 8 months ago

Thanks a lot @ablot! You have diagnosed the issue correctly, the sphinx-sitemap in conf.py should be sphinx_sitemap. We will implement the fix asap.

niksirbi commented 8 months ago

Should be fixed now.