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.

Sign up for GitHub

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

Jump to bottom

📝 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

Commits on Jun 4, 2022

  1. ➕ Add jupyter-book 

    Create beautiful, publication-quality books and documents from computational content!
    @weiji14
    weiji14 committed Jun 4, 2022
    Configuration menu
    Copy the full SHA
    d583789 View commit details
    Browse the repository at this point in the history

  2. 🌱 Initialize Jupyter Book with API page 

    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.
    @weiji14
    weiji14 committed Jun 4, 2022
    Configuration menu
    Copy the full SHA
    0f9b8a9 View commit details
    Browse the repository at this point in the history

  3. 🚀 Deploy docs to GitHub Pages using GitHub Actions 

    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 committed Jun 4, 2022
    Configuration menu
    Copy the full SHA
    35e7f62 View commit details
    Browse the repository at this point in the history

  4. 📸 Temporarily trigger docs build

    @weiji14
    weiji14 committed Jun 4, 2022
    Configuration menu
    Copy the full SHA
    6730641 View commit details
    Browse the repository at this point in the history

  5. 🩹 Fix missing API docs by installing zen3geo package 

    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 committed Jun 4, 2022
    Configuration menu
    Copy the full SHA
    c2a190f View commit details
    Browse the repository at this point in the history

  6. [skip-ci] Disable docs build and remove bibtex reference

    @weiji14
    weiji14 committed Jun 4, 2022
    Configuration menu
    Copy the full SHA
    f52ac11 View commit details
    Browse the repository at this point in the history