Skip to content
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
merged 6 commits into from
Jun 4, 2022
Merged

📝 Initialize documentation page #3

merged 6 commits into from
Jun 4, 2022

Conversation

weiji14
Copy link
Owner

@weiji14 weiji14 commented Jun 4, 2022

Documentation built with Jupyter-Book/Sphinx. Deployed to GitHub Pages via GitHub Actions.

Preview at https://weiji14.github.io/zen3geo

TODO:

  • Add jupyter-book dev dependency
  • Initialize no-frills documentation built with Jupyter-Book
  • Setup GitHub Actions CI to build docs and push to GitHub Pages
  • Use minimalistic theme (next time)

Note, need to update settings at https://github.com/weiji14/zen3geo/settings/pages

image

References:

Create beautiful, publication-quality books and documents from computational content!
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
@weiji14 weiji14 added the documentation Improvements or additions to documentation label Jun 4, 2022
@weiji14 weiji14 added this to the 0.1.0 milestone Jun 4, 2022
@weiji14 weiji14 self-assigned this Jun 4, 2022
Need to do `pip install .` so that API docs actually render. Also discovered issue with pyproject.toml build-system so fixed that too.
@weiji14 weiji14 marked this pull request as ready for review June 4, 2022 21:55
@weiji14 weiji14 merged commit e11f10e into main Jun 4, 2022
@weiji14 weiji14 deleted the docs branch June 4, 2022 21:56
@weiji14 weiji14 added the skip-changelog Skip adding Pull Request to changelog label 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).
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant