Skip to content

Doc: Enable nitpicky#292

Merged
james-d-mitchell merged 4 commits intolibsemigroups:v1from
Joseph-Edwards:nitpicky
Jun 27, 2025
Merged

Doc: Enable nitpicky#292
james-d-mitchell merged 4 commits intolibsemigroups:v1from
Joseph-Edwards:nitpicky

Conversation

@Joseph-Edwards
Copy link
Copy Markdown
Collaborator

This PR enables the Sphinx config option nitpicky, and addresses any resultant warnings. In nitpicky mode, Sphinx will warn about all references where the target cannot be found.

Additionally, this PR updates conf.py. Unused options have been removed, each setting has an explanation, and the options are ordered in the same way as they are in the sphinx documentation.

Copy link
Copy Markdown
Member

@james-d-mitchell james-d-mitchell left a comment

Choose a reason for hiding this comment

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

Looks great!

Comment thread docs/source/conf.py
project = "libsemigroups_pybind11"

# The project’s author(s)
author = "Joseph Edwards, James Mitchell, Maria Tsalakou, Murray Whyte"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

And Reinis!

Comment thread docs/source/conf.py
# A copyright statement. The string '%Y' will be replaced with the current
# four-digit year.
project_copyright = (
"2021-%Y, Joseph Edwards, James Mitchell, Maria Tsalakou, Murray Whyte"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Comment thread src/konieczny.cpp
)pbdoc");
} // bind_konieczny
} // namespace
} // namespace
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice

@james-d-mitchell james-d-mitchell merged commit 32c8c25 into libsemigroups:v1 Jun 27, 2025
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.

2 participants