-
-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📝 Initialize documentation page #3
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
Create beautiful, publication-quality books and documents from computational content!
Use `jupyter-book create docs/`and follow https://jupyterbook.org/en/stable/advanced/developers.html#api-reference-from-docstrings to get API docs automatically generated.
Continuous Integration workflow to build the documentation HTML pages using Jupyter Book and publish it online to GitHub Pages. Based on https://jupyterbook.org/en/stable/publish/gh-pages.html#automatically-host-your-book-with-github-actions
Need to do `pip install .` so that API docs actually render. Also discovered issue with pyproject.toml build-system so fixed that too.
This was referenced Jun 7, 2022
weiji14
added a commit
that referenced
this pull request
Sep 1, 2022
Let build-backend depend only on poetry-core instead of full poetry. Partial revert of c2a190f in #3. Motivated by conda-forge/staged-recipes#20198 (comment).
weiji14
added a commit
that referenced
this pull request
Sep 1, 2022
* ⬆️ Bump poetry from 1.2.0rc1 to 1.2.0 Bumps [poetry](https://github.com/python-poetry/poetry) from 1.2.0rc1 to 1.2.0. - [Release notes](https://github.com/python-poetry/poetry/releases) - [Changelog](https://github.com/python-poetry/poetry/blob/master/CHANGELOG.md) - [Commits](python-poetry/poetry@1.2.0rc1...1.2.0) * 🎨 Use the pretty name of dependencies in poetry.lock file Make the lockfile consistent with poetry 1.2.0, see python-poetry/poetry#6243. * 👽 Use poetry-core instead of poetry in build system Let build-backend depend only on poetry-core instead of full poetry. Partial revert of c2a190f in #3. Motivated by conda-forge/staged-recipes#20198 (comment).
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
skip-changelog
Skip adding Pull Request to changelog
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.
Documentation built with Jupyter-Book/Sphinx. Deployed to GitHub Pages via GitHub Actions.
Preview at https://weiji14.github.io/zen3geo
TODO:
Note, need to update settings at https://github.com/weiji14/zen3geo/settings/pages
References: