Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Makefile and make.bat files used for automatic generation of documentation. #5347

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

ljfp
Copy link
Contributor

@ljfp ljfp commented Sep 5, 2024

Description

Fixing this bug --> #5346
Checklist:

  • I've made sure that tests are updated accordingly (especially if adding or updating a template option)
    I've used Tox to run the templates test suite.
  • I've updated the documentation or confirm that my change doesn't require any updates
    This doesn't seem relevant for the fix.

Rationale

Fix: #5346

Both the "Makefile" and "make.bat" files are passing a non-existent argument ("help") to the -M/-b option. These are the only valid arguments: https://www.sphinx-doc.org/en/master/usage/builders/index.html

From that list, the most logical Builder to use is "html" since that's the one that is used later with sphinx-autobuild.

…. They were using a non-existent Builder called "help". I changed it to "html" since that is the one used by sphinx-autobuild.
@foarsitter
Copy link
Collaborator

Thanks for your contribution @ljfp!

@foarsitter foarsitter merged commit 2b37524 into cookiecutter:master Sep 23, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs (sphinx-autobuild) fails with Docker
2 participants