Commit 9b96a7a7 authored by Nicholas Bollweg's avatar Nicholas Bollweg
Browse files

start working on docs for real

parent 1e85b319
......@@ -14,6 +14,7 @@ node_modules
coverage
*.map.js
*.bundle.js
docs/_build
# jetbrains IDE stuff
.idea/
......
node_modules
**/node_modules
**/lib
**/node_modules
**/package.json
**/static
build
docs/_build
node_modules
# CHANGELOG
## jupyterlite 0.1.0
> TBD
# Contributing to JupyterLite
# Contributing
Thanks for contributing to JupyterLite!
......@@ -148,5 +148,5 @@ JupyterLite become _real_ as [pull requests].
[new issue]: https://github.com/jtpio/jupyterlite/issues/new
[pull requests]: https://github.com/jtpio/jupyterlite/pulls
[repo]: https://github.com/jtpio/jupyterlite
[coc]: (https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md)
[mambaforge]: https://github.com/conda-forge/miniforge/
[coc]: https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md
[mambaforge]: https://github.com/conda-forge/miniforge
{
"name": "@jupyterlite/app",
"version": "0.1.0"
"version": "0.1.0",
"homepage": "https://github.com/jtpio/jupyterlite",
"bugs": {
"url": "https://github.com/jtpio/jupyterlite/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/jtpio/jupyterlite"
},
"license": "BSD-3-Clause",
"author": "JupyterLite Contributors"
}
```{include} ../CHANGELOG.md
```
"""documentation for jupyterlite"""
import json
import datetime
from pathlib import Path
HERE = Path(__file__).parent
ROOT = HERE.parent
APP_PKG = ROOT / "app/package.json"
APP_DATA = json.loads(APP_PKG.read_text(encoding="utf-8"))
# metadata
author = APP_DATA["author"]
project = author.replace("Contributors", "").strip()
copyright = f"{datetime.date.today().year}, {author}"
# The full version, including alpha/beta/rc tags
release = APP_DATA["version"]
# The short X.Y version
version = ".".join(release.rsplit(".", 1))
# files
exclude_patterns = [".ipynb_checkpoints", "**/.ipynb_checkpoints", "**/~.*"]
# sphinx config
extensions = ["sphinx.ext.autosectionlabel", "myst_nb"]
autosectionlabel_prefix_document = True
# theme
html_theme = "pydata_sphinx_theme"
html_logo = "_static/icon.svg"
html_theme_options = {
"github_url": APP_DATA["homepage"],
"use_edit_page_button": True,
}
html_context = {
"github_user": "jtpio",
"github_repo": "jupyterlite",
"github_version": "main",
"doc_path": "docs",
}
html_static_path = ["_static"]
```{include} ../CONTRIBUTING.md
```
......@@ -17,3 +17,4 @@ dependencies:
# docs
- sphinx
- pydata-sphinx-theme
- myst-nb
```{include} ../README.md
```
```{toctree}
contributing
changelog
```
......@@ -58,7 +58,7 @@ def task_build():
yield dict(
name=f"py:{name}",
file_dep=[*py_pkg.rglob("*.py"), py_pkg / "pyproject.toml"],
actions=[doit.tools.CmdAction(["flit", "build"], shell=False, cwd=py_pkg)],
actions=[U.do("flit", "build", cwd=py_pkg)],
# TODO: get version
targets=[wheel],
)
......@@ -96,6 +96,15 @@ def task_build():
)
def task_docs():
yield dict(
name="sphinx",
file_dep=[*P.DOCS_MD, *P.DOCS_PY],
actions=[U.do("sphinx-build", "-M", "html", P.DOCS, B.DOCS)],
targets=[B.DOCS_BUILDINFO],
)
class C:
NAME = "jupyterlite"
APPS = ["classic", "lab"]
......@@ -122,6 +131,10 @@ class P:
# docs
README = ROOT / "README.md"
CONTRIBUTING = ROOT / "CONTRIBUTING.md"
CHANGELOG = ROOT / "CHANGELOG.md"
DOCS = ROOT / "docs"
DOCS_PY = [*DOCS.rglob("*.py")]
DOCS_MD = [*DOCS.rglob("*.md"), README, CONTRIBUTING, CHANGELOG]
# demo
BINDER = ROOT / ".binder"
......@@ -149,10 +162,14 @@ class L:
# linting
ALL_TS = [*P.PACKAGES.rglob("*/src/**/*.js"), *P.PACKAGES.rglob("*/src/**/*.ts")]
ALL_JSON = [*P.PACKAGE_JSONS, *P.APP_JSONS, P.ROOT_PACKAGE_JSON, *ALL_TS]
ALL_MD = [P.CONTRIBUTING, P.README, *P.CI.rglob("*.md")]
ALL_MD = [*P.CI.rglob("*.md"), *P.DOCS_MD]
ALL_YAML = [*P.BINDER.glob("*.yml"), *P.CI.rglob("*.yml")]
ALL_PRETTIER = [*ALL_JSON, *ALL_MD, *ALL_YAML]
ALL_BLACK = [P.DODO, *sum([[*p.rglob("*.py")] for p in P.PYOLITE_PACKAGES], [])]
ALL_BLACK = [
*P.DOCS_PY,
P.DODO,
*sum([[*p.rglob("*.py")] for p in P.PYOLITE_PACKAGES], []),
]
class B:
......@@ -165,6 +182,9 @@ class B:
BUILD = P.ROOT / "build"
DIST = P.ROOT / "dist"
APP_PACK = DIST / f"""jupyterlite-app-{D.APP["version"]}.tgz"""
DOCS = P.DOCS / "_build"
DOCS_HTML = DOCS / "html"
DOCS_BUILDINFO = DOCS_HTML / ".buildinfo"
OK = BUILD / "ok"
OK_PRETTIER = OK / "prettier"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment