Docs/versioned docs (#236) #237
Merged
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
* 🔧 build: add mkdocs to project * 📝 docs: rewrite getting started page to mkdocs structure note: mkdocstrings still has to be added to support linking to library code * 📝 docs: translate dash app integration page to mkdocs structure * 📝 docs: translate FAQ page to mkdocs structure * 🔧 build: add mkdocstrings dependency * 🔧 build: add mkdocs-gen-files dependency * 🔧 build: add automatic code API reference page creation * 📝 docs: fix links to API documentation * 📝 build: add mkdocs-section-index * 📝 docs: fix registering documentation * 📝 docs: fix docs for figure_resampler dir * 📝 docs: fix aggregation documentation * 📝 docs: add versioning to documentation * 🔥 chore: remove old documentation * 👷 build: add mkdocs CI/CD step * 🔧 build: add QOL docs extensions * 📝 docs: add buttons for github, PyPi and DOI * ➖ chore: remove old sphinx dependencies * 🎨 chore: format code documentation * ✏️ chore: remove random text in docstring * 🎨 chore: format code * 👷 build: replace tag push with PR push
* 🔧 build: add mkdocs to project * 📝 docs: rewrite getting started page to mkdocs structure note: mkdocstrings still has to be added to support linking to library code * 📝 docs: translate dash app integration page to mkdocs structure * 📝 docs: translate FAQ page to mkdocs structure * 🔧 build: add mkdocstrings dependency * 🔧 build: add mkdocs-gen-files dependency * 🔧 build: add automatic code API reference page creation * 📝 docs: fix links to API documentation * 📝 build: add mkdocs-section-index * 📝 docs: fix registering documentation * 📝 docs: fix docs for figure_resampler dir * 📝 docs: fix aggregation documentation * 📝 docs: add versioning to documentation * 🔥 chore: remove old documentation * 👷 build: add mkdocs CI/CD step * 🔧 build: add QOL docs extensions * 📝 docs: add buttons for github, PyPi and DOI * ➖ chore: remove old sphinx dependencies * 🎨 chore: format code documentation * ✏️ chore: remove random text in docstring * 🎨 chore: format code * 👷 build: replace tag push with PR push * 👷 build: fix mike deployment
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## main #237 +/- ##
==========================================
- Coverage 96.87% 96.86% -0.01%
==========================================
Files 14 14
Lines 1023 1022 -1
==========================================
- Hits 991 990 -1
Misses 32 32
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
* 🔧 build: add mkdocs to project * 📝 docs: rewrite getting started page to mkdocs structure note: mkdocstrings still has to be added to support linking to library code * 📝 docs: translate dash app integration page to mkdocs structure * 📝 docs: translate FAQ page to mkdocs structure * 🔧 build: add mkdocstrings dependency * 🔧 build: add mkdocs-gen-files dependency * 🔧 build: add automatic code API reference page creation * 📝 docs: fix links to API documentation * 📝 build: add mkdocs-section-index * 📝 docs: fix registering documentation * 📝 docs: fix docs for figure_resampler dir * 📝 docs: fix aggregation documentation * 📝 docs: add versioning to documentation * 🔥 chore: remove old documentation * 👷 build: add mkdocs CI/CD step * 🔧 build: add QOL docs extensions * 📝 docs: add buttons for github, PyPi and DOI * ➖ chore: remove old sphinx dependencies * 🎨 chore: format code documentation * ✏️ chore: remove random text in docstring * 🎨 chore: format code * 👷 build: replace tag push with PR push * 👷 build: fix mike deployment
* 🔧 build: add mkdocs to project * 📝 docs: rewrite getting started page to mkdocs structure note: mkdocstrings still has to be added to support linking to library code * 📝 docs: translate dash app integration page to mkdocs structure * 📝 docs: translate FAQ page to mkdocs structure * 🔧 build: add mkdocstrings dependency * 🔧 build: add mkdocs-gen-files dependency * 🔧 build: add automatic code API reference page creation * 📝 docs: fix links to API documentation * 📝 build: add mkdocs-section-index * 📝 docs: fix registering documentation * 📝 docs: fix docs for figure_resampler dir * 📝 docs: fix aggregation documentation * 📝 docs: add versioning to documentation * 🔥 chore: remove old documentation * 👷 build: add mkdocs CI/CD step * 🔧 build: add QOL docs extensions * 📝 docs: add buttons for github, PyPi and DOI * ➖ chore: remove old sphinx dependencies * 🎨 chore: format code documentation * ✏️ chore: remove random text in docstring * 🎨 chore: format code * 👷 build: replace tag push with PR push * 👷 build: fix mike deployment * 👷 build: fix git gh-pages fetching
jonasvdd
commented
Jul 12, 2023
.github/workflows/deploy-mkdocs.yml
Outdated
|
|
||
| on: | ||
| push: | ||
| pull_request: |
There was a problem hiding this comment.
dit moet weer terug aangepast worden.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
🔧 build: add mkdocs to project
📝 docs: rewrite getting started page to mkdocs structure note:
mkdocstrings still has to be added to support linking to library code
📝 docs: translate dash app integration page to mkdocs structure
📝 docs: translate FAQ page to mkdocs structure
🔧 build: add mkdocstrings dependency
🔧 build: add mkdocs-gen-files dependency
🔧 build: add automatic code API reference page creation
📝 docs: fix links to API documentation
📝 build: add mkdocs-section-index
📝 docs: fix registering documentation
📝 docs: fix docs for figure_resampler dir
📝 docs: fix aggregation documentation
📝 docs: add versioning to documentation
🔥 chore: remove old documentation
👷 build: add mkdocs CI/CD step
🔧 build: add QOL docs extensions
📝 docs: add buttons for github, PyPi and DOI
➖ chore: remove old sphinx dependencies
🎨 chore: format code documentation
✏️ chore: remove random text in docstring
🎨 chore: format code
👷 build: replace tag push with PR push