Add new base for docs #450
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kevinkjt2000
approved these changes
Jan 1, 2023
| pkg_meta = _get_project_meta() | ||
| project = str(pkg_meta["name"]) | ||
| copyright = str(date.today().year) + ", py-mine" | ||
| author = "py-mine" |
There was a problem hiding this comment.
I'd like to still give attribution to dinnerbone here. I'll look for a way to add py-mine to the list in pyproject.toml and use pkg_meta["authors"] here.
There was a problem hiding this comment.
I didn't notice that you mentioned Dinnerbone as author before, here it was just generated value.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is based on my template, but without
sphinx-autoapidependency. The reason for this is thatmcstatushas explicitly defined the Public API, and we do not need to document the entire app in a quick way.I also added this on top of current
sphinx-docschanges, to not produce merge conflicts that will stop GitHub from merging this PR. I'm sure that there exists a better way, I'm open for ideas.This PR also fixes some small "issues" in
CONTRIBUTING.mdandREADME.md, without them,sphinxwill work incorrectly.P.S. Some things from @kevinkjt2000's work were also added here.