diff --git a/.gitignore b/.gitignore index cc7325e3..4ea7b5de 100644 --- a/.gitignore +++ b/.gitignore @@ -73,6 +73,7 @@ instance/ # Sphinx documentation docs/_build/ docs/_env/ +newdocs/_env/ # PyBuilder target/ diff --git a/newdocs/Makefile b/newdocs/Makefile new file mode 100644 index 00000000..af47bc08 --- /dev/null +++ b/newdocs/Makefile @@ -0,0 +1,46 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build +CONDA_ENV ?= _env + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +env := $(CONDA_ENV) +conda_run := conda run -p $(env) + +setup: + @if [ -z "$${CONDA_SHLVL:+x}" ]; then echo "Conda is not installed." && exit 1; fi + $(CONDA_EXE) env $(shell [ -d $(env) ] && echo update || echo create) -p $(env) --file environment.yml + +clean: + rm -rf $(BUILDDIR) + +clean-all: clean + rm -rf $(env) *.egg-info + +shell: + @export CONDA_ENV_PROMPT='<{name}>' + @echo 'conda activate $(env)' + +htmlserve: html + @echo 'visit docs at http://localhost:8080' + python -m http.server -d "$(BUILDDIR)/html/" 8080 + +livehtml: + sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + + +.PHONY: help Makefile setup clean clean-all shell + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/newdocs/docs/advanced-user-guide.md b/newdocs/docs/advanced-user-guide.md new file mode 100644 index 00000000..ead02231 --- /dev/null +++ b/newdocs/docs/advanced-user-guide.md @@ -0,0 +1 @@ +# Features diff --git a/newdocs/docs/contributing.md b/newdocs/docs/contributing.md new file mode 100644 index 00000000..854139a3 --- /dev/null +++ b/newdocs/docs/contributing.md @@ -0,0 +1 @@ +# Contributing diff --git a/newdocs/docs/features.md b/newdocs/docs/features.md new file mode 100644 index 00000000..35e49079 --- /dev/null +++ b/newdocs/docs/features.md @@ -0,0 +1 @@ +# What is PyScript - Features diff --git a/newdocs/docs/user-guide.md b/newdocs/docs/user-guide.md new file mode 100644 index 00000000..ead02231 --- /dev/null +++ b/newdocs/docs/user-guide.md @@ -0,0 +1 @@ +# Features