docs: Enable githubpages, intersphinx, and type hints #430
Conversation
This file contains hidden or 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
- githubpages: Automatically create .nojekyll file - intersphinx: Allow linking to docs for the Python stdlib and other packages
bkeryan
requested review from
csjall,
dixonjoel,
nstokes-nati and
pbirkhol-ni
as code owners
1 task
bkeryan
commented
Oct 4, 2023
bkeryan
changed the title
pbirkhol-ni
approved these changes
Oct 5, 2023
DelpireNI
approved these changes
Oct 5, 2023
This was referenced Jan 26, 2024
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.
What does this Pull Request accomplish?
Enable more Sphinx extensions:
.nojekyllfileRemove
touch docs/.nojekyllfrom GitHub workflows.Show type hints in attribute/parameter descriptions.
Why should this Pull Request be merged?
Enhance documentation by linking to other docs and showing type hints.
Simplify GitHub workflows.
What testing has been done?
Built docs locally. Verified that the
.nojekyllfile is created and that hyperlinks to stdlib and nidcpower work.