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

DOC: interactive docs with marimo #87

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ jobs:
uses: actions/upload-artifact@v4
with:
name: docs-build
path: mybook/_build/html
path: docs/_build/html
11 changes: 3 additions & 8 deletions mybook/_config.yml → docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,16 @@ title: Documentation
author: Matt Haberland
logo: logo.png

# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks: force

# Define the name of the latex output file for PDF builds
latex:
latex_documents:
targetname: book.tex

# Information about where the book exists on the web
repository:
url: https://github.com/mdhaber/marray # Online location of your book
path_to_book: mybook # Optional path to your book, relative to the repository root
branch: main # Which branch of the repository should be used when creating links (optional)
url: https://github.com/mdhaber/marray # Online location of your book
path_to_book: docs # Optional path to your book, relative to the repository root
branch: main # Which branch of the repository should be used when creating links (optional)

# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
Expand Down
2 changes: 1 addition & 1 deletion mybook/_toc.yml → docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
format: jb-book
root: intro
chapters:
- file: tutorial
- file: tutorial
2 changes: 1 addition & 1 deletion mybook/intro.md → docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ Documentation provided by attributes of `xp` are exposed in the `mxp`
namespace and are accessible via `help`. For more information, please see
[the tutorial](https://colab.research.google.com/drive/1LaZCK3jvnf40qEjWEhqhhc5e8IWy7vuo?usp=sharing).

[^1]: The MArray logo is a nod to NumPy's logo, but MArray is not affiliated with the NumPy project.
[^1]: The MArray logo is a nod to NumPy's logo, but MArray is not affiliated with the NumPy project.
File renamed without changes
File renamed without changes
Loading