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

Update documentation to mention that output directory is configurable #1785

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

WilliamDEdwards
Copy link

The documentation says that the output directory is the current directory. However, with PRs #452 and #452, it is configurable.

With this commit, the documentation simply links to CLI options page, not to the CLI option entry on it. How do I do that with :doc?

The documentation says that the output directory is the current directory. However, with PRs cookiecutter#452 and cookiecutter#452, it is configurable.
@WilliamDEdwards WilliamDEdwards marked this pull request as draft October 3, 2022 09:48
@WilliamDEdwards
Copy link
Author

I'm fixing the failing workflow when the comment in the PR description has been processed. I'm awaiting feedback.

@jensens
Copy link
Contributor

jensens commented Oct 3, 2022

The command line options block is generated in code (Sphinx plugin sphinx_click.ext). I am not sure if the generated option can be referenced. But if an option can be referenced, then this should work for an generated one too, because in the end both are parsed the same.

Update there is an issue dealing with the problem here click-contrib/sphinx-click#37

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.

None yet

2 participants