Added docs through MKDocs, hosted on Github Pages #72
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
When the tracker thread is stopped in Python 3.11 in Github Actions, the last message logged to the INFO channel is not "Monitoring thread ended." but instead "The following components were found: [...]". This breaks our tests only in Github Actions. My hypothesis is that this happens due to a race, so this commit tests that in CI. added informative comment
Add Python 3.8-3.11 in CI test setup, and fix several version-related bugs.
Fixed syntax error
Add python 3.7 to test pipeline
type hints code formatting
When the tracker thread is stopped in Python 3.11 in Github Actions, the last message logged to the INFO channel is not "Monitoring thread ended." but instead "The following components were found: [...]". This breaks our tests only in Github Actions. My hypothesis is that this happens due to a race, so this commit tests that in CI. added informative comment Added doc infrastructure using mkdocs and mkdocstrings added parsing docs added better CLI docs Improved CarbonTracker docs Redid first page of docs Fix on python3.8 and add slightly more documentation HPC documentation Parsing documentation align spelling of carbontracker in docs move HPC to index.md Expand Getting Started added Github action for pushing docs fix yml formatting Many type improvements more type hints
type hints code formatting fix test
make tests time-independent fixed some typing
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 PR adds type hints and docs through mkdocs and mkdocstrings. The docs are hosted on Github Pages through Github Actions. A current version can be seen on https://snailed.github.io/carbontracker/ and the final version will be seen on http://lfwa.github.io/carbontracker/.
I plan to change the DNS settings such that the page is accessible through docs.carbontracker.info or similar and then make a link at carbontracker.info.