Add yardang option, fixes #57

copier.yaml

@@ -65,3 +65,8 @@ python_version_primary:
     "3.12":
       value: "3.12"
   help: Primary version of Python to use in CI/CD
+
+add_docs:
+  type: bool
+  default: false
+  help: Add documentation using Yardang/Sphinx

cpp/.github/workflows/{% if add_docs %}docs.yaml{% endif %}.jinja

@@ -0,0 +1,23 @@
+name: Docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-ext/python/setup@main
+      - uses: actions-ext/node/setup@main
+      - run: uv pip install .
+      - run: uv pip install yardang
+      - run: yardang build
+      - uses: peaceiris/actions-gh-pages@v4
+        with:
+          publish_branch: gh-pages
+          github_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
+          publish_dir: docs/html

cpp/.gitignore.jinja

@@ -129,8 +129,9 @@ dmypy.json
 .pyre/
 
 # Documentation
-docs/_build/
 /site
+index.md
+docs/_build/
 docs/api
 docs/index.md
 docs/html

examples/cpp.yaml

@@ -1,5 +1,6 @@
 ---
-add_extension: cpp 
+add_docs: true
+add_extension: cpp
 email: 3105306+timkpaine@users.noreply.github.com
 github: python-project-templates
 project_description: A C++-Python project template

examples/js.yaml

@@ -1,5 +1,6 @@
 ---
-add_extension: js 
+add_docs: true
+add_extension: js
 email: 3105306+timkpaine@users.noreply.github.com
 github: python-project-templates
 project_description: A JavaScript-Python project template

examples/jupyter.yaml

@@ -1,4 +1,5 @@
 ---
+add_docs: true
 add_extension: jupyter
 email: 3105306+timkpaine@users.noreply.github.com
 github: python-project-templates

examples/python.yaml

@@ -1,4 +1,5 @@
 ---
+add_docs: true
 add_extension: python
 email: 3105306+timkpaine@users.noreply.github.com
 github: python-project-templates

examples/rust.yaml

@@ -1,4 +1,5 @@
 ---
+add_docs: true
 add_extension: rust
 email: 3105306+timkpaine@users.noreply.github.com
 github: python-project-templates

js/.github/workflows/{% if add_docs %}docs.yaml{% endif %}.jinja

@@ -0,0 +1,23 @@
+name: Docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-ext/python/setup@main
+      - uses: actions-ext/node/setup@main
+      - run: uv pip install .
+      - run: uv pip install yardang
+      - run: yardang build
+      - uses: peaceiris/actions-gh-pages@v4
+        with:
+          publish_branch: gh-pages
+          github_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
+          publish_dir: docs/html

js/.gitignore.jinja

@@ -125,8 +125,9 @@ dmypy.json
 .pyre/
 
 # Documentation
-docs/_build/
 /site
+index.md
+docs/_build/
 docs/api
 docs/index.md
 docs/html

jupyter/.github/workflows/{% if add_docs %}docs.yaml{% endif %}.jinja

@@ -0,0 +1,23 @@
+name: Docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-ext/python/setup@main
+      - uses: actions-ext/node/setup@main
+      - run: uv pip install .
+      - run: uv pip install yardang
+      - run: yardang build
+      - uses: peaceiris/actions-gh-pages@v4
+        with:
+          publish_branch: gh-pages
+          github_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
+          publish_dir: docs/html

jupyter/.gitignore.jinja

@@ -125,8 +125,9 @@ dmypy.json
 .pyre/
 
 # Documentation
-docs/_build/
 /site
+index.md
+docs/_build/
 docs/api
 docs/index.md
 docs/html

python/.github/workflows/{% if add_docs %}docs.yaml{% endif %}.jinja

@@ -0,0 +1,23 @@
+name: Docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-ext/python/setup@main
+      - uses: actions-ext/node/setup@main
+      - run: uv pip install .
+      - run: uv pip install yardang
+      - run: yardang build
+      - uses: peaceiris/actions-gh-pages@v4
+        with:
+          publish_branch: gh-pages
+          github_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
+          publish_dir: docs/html

python/.gitignore

@@ -125,11 +125,11 @@ dmypy.json
 .pyre/
 
 # Documentation
-docs/_build/
 /site
+index.md
+docs/_build/
 docs/api
 docs/index.md
-_template/labextension
 
 # Jupyter
 .ipynb_checkpoints

python/pyproject.toml.jinja

@@ -115,3 +115,13 @@ section-order = ["future", "standard-library", "third-party", "first-party", "lo
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]
+
+{%- if add_docs %}
+
+[tool.yardang]
+title = "{{ project_name }}"
+root = "README.md"
+pages = []
+use-autoapi = true
+
+{% endif -%}

rust/.github/workflows/{% if add_docs %}docs.yaml{% endif %}.jinja

@@ -0,0 +1,23 @@
+name: Docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-ext/python/setup@main
+      - uses: actions-ext/node/setup@main
+      - run: uv pip install .
+      - run: uv pip install yardang
+      - run: yardang build
+      - uses: peaceiris/actions-gh-pages@v4
+        with:
+          publish_branch: gh-pages
+          github_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
+          publish_dir: docs/html

rust/.gitignore

@@ -125,8 +125,9 @@ dmypy.json
 .pyre/
 
 # Documentation
-docs/_build/
 /site
+index.md
+docs/_build/
 docs/api
 docs/index.md
 docs/html