Merge pull request #542 from TeoZosa/drop-cli-usage-doc-page-autogene…

…ration 📝 Drop typer CLI usage doc generation
TeoZosa · Feb 27, 2022 · 6327369 · 6327369
2 parents 5e2200e + 815b94a
commit 6327369
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 32 deletions.
diff --git a/README.md b/README.md
@@ -301,8 +301,6 @@ cruft update
 
 - Documentation building
   with [Sphinx](https://www.sphinx-doc.org/en/master/index.html)
-  - CLI reference
-    with the [typer-cli documentation generator](https://typer.tiangolo.com/typer-cli/#generate-docs-with-typer-cli)
   - Rich automatic documentation from type annotations and docstrings (NumPy, Google,
     etc.)
     with [`sphinx-autoapi`](https://github.com/readthedocs/sphinx-autoapi)

diff --git a/{{cookiecutter.project_slug}}/docs/Makefile b/{{cookiecutter.project_slug}}/docs/Makefile
@@ -28,14 +28,7 @@ clean:
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-#{%- if cookiecutter.project_boilerplate_type == 'cli' %}
-%: USAGE_PAGE := source/usage.md
-#{%- endif %}
 %: Makefile
-#{%- if cookiecutter.project_boilerplate_type == 'cli' %}
-	@echo "# Usage" > "$(USAGE_PAGE)"
-	poetry run typer $(shell git rev-parse --show-toplevel)/{{cookiecutter.package_name}}/main.py utils docs --name {{cookiecutter.package_name}} | tail -n +2 >> "$(USAGE_PAGE)"
-#{%- endif %}
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 ifneq ($(filter html,$(MAKECMDGOALS)),)
 ifneq ($(shell command -v open),)

diff --git a/{{cookiecutter.project_slug}}/docs/source/usage.md b/{{cookiecutter.project_slug}}/docs/source/usage.md
diff --git a/{{cookiecutter.project_slug}}/pyproject.toml b/{{cookiecutter.project_slug}}/pyproject.toml
@@ -64,17 +64,14 @@ sphinx = { version = "^4.4.0", optional = true}
 sphinx-autoapi = { version = "^1.8.4", optional = true}
 sphinx-rtd-theme = { version = "^1.0.0", optional = true}
 sphinxcontrib-confluencebuilder = { version = "^1.7.1", optional = true}
-{%- if cookiecutter.project_boilerplate_type == 'cli' %}
-typer-cli = { version = "^0.0.12", optional = true}
-{%- endif %}
 types-emoji = { version = "^1.2.7", optional = true} # PEP 561 compliant stub package for mypy
 
 # Project-Specific
 python-dotenv = "^0.19.2"
 {%- if cookiecutter.project_boilerplate_type == 'cli' %}
 importlib-metadata = "^4.11.1"
 rich = "^11.2.0"
-typer = {extras = ["all"], version = "^0.3.2"}
+typer = {extras = ["all"], version = "^0.4.0"}
 {%- else %}
 numpy = "^1.22.2"
 pandas = "^1.4.1"
@@ -143,9 +140,6 @@ docs = [
     "sphinx-autoapi",
     "sphinx-rtd-theme",
     "sphinxcontrib-confluencebuilder",
-{%- if cookiecutter.project_boilerplate_type == 'cli' %}
-    "typer-cli",
-{%- endif %}
     "types-emoji",
 ]