Skip to content

Minor fixes#608

Open
odadacharles wants to merge 2 commits into
canonical:mainfrom
odadacharles:minor-fixes
Open

Minor fixes#608
odadacharles wants to merge 2 commits into
canonical:mainfrom
odadacharles:minor-fixes

Conversation

@odadacharles

Copy link
Copy Markdown
Contributor
  • Have you updated CHANGELOG.md with relevant non-documentation file changes?
  • Have you updated the documentation for this change?

According to the sphinx-llm docs, the second = in SPHINX_AUTOBUILD_OPTS ?= -D=llms_txt_enabled=0 is supposed to be a space.
Ref: https://pypi.org/project/sphinx-llm/

Signed-off-by: Charles Odada <charles.odada@canonical.com>
Signed-off-by: Charles Odada <charles.odada@canonical.com>
@odadacharles

Copy link
Copy Markdown
Contributor Author

This doesn't seem to affect the running of the make run command, so it may not be a necessary change.

Comment thread docs/Makefile
SPHINX_HOST ?= 127.0.0.1
SPHINX_PORT ?= 8000
SPHINX_AUTOBUILD_OPTS ?= -D=llms_txt_enabled=0
SPHINX_AUTOBUILD_OPTS ?= -D llms_txt_enabled=0

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I support this change because it's one less noise character.

As far as I can tell, though, -D= is technically fine. -D/--define can only assign one value, so users won't run into argument parsing issues if they leave it in. If it supported variadic parameters, then the technical case would be stronger.

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.

2 participants