Skip to content

Commit 77cfeb5

Browse files
MisklerMiskler
authored
Merge pull request #7 from Open-Inflation/codex/auto-generate-documentation-with-mkdocs
Codex/auto generate documentation with mkdocs
2 parents da676e4 + 562d13f commit 77cfeb5

97 files changed

Lines changed: 52465 additions & 2539 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "🐛 Bug report"
2+
description: Report something that isn’t working as intended
3+
title: "[Bug] <short title>"
4+
labels: ["bug"]
5+
assignees: ["miskler"]
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
**Thanks for taking the time to report a bug!**
12+
13+
- type: checkboxes
14+
id: area
15+
attributes:
16+
label: Affected area(s)
17+
description: Check all that apply.
18+
options:
19+
- label: core
20+
- label: anti-bot
21+
- label: python interface
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: steps
27+
attributes:
28+
label: What did you do?
29+
description: Step-by-step commands or actions to reproduce the issue.
30+
render: plaintext
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: actual
36+
attributes:
37+
label: What happened?
38+
description: Paste error messages or describe the incorrect behaviour. Logs can be attached below.
39+
render: plaintext
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: expected
45+
attributes:
46+
label: What did you expect to happen?
47+
render: plaintext
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: logs
53+
attributes:
54+
label: Logs / screenshots
55+
description: Drag & drop log files or screenshots here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: 📖 Read the docs
5+
url: https://miskler.github.io/jsonschema-diff/basic/quick_start/
6+
about: Start here for “how-to” questions.
7+
- name: 💬 Discord server (Discussions)
8+
url: https://discord.gg/UnJnGHNbBp
9+
about: General Q&A and community support.

‎.github/ISSUE_TEMPLATE/documentation_issue.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "📚 Docs issue"
2+
description: Flag inaccurate or missing documentation
3+
title: "[Docs] <short title>"
4+
labels: ["documentation"]
5+
assignees: ["miskler"]
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
**Help us keep the docs sharp!**
12+
13+
- type: input
14+
id: url
15+
attributes:
16+
label: Link to the problematic page
17+
placeholder: "https://example.com/docs/..."
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: problem
23+
attributes:
24+
label: What’s broken or unclear?
25+
render: markdown
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: screenshots
31+
attributes:
32+
label: Screenshots (optional)
33+
description: Drag & drop images if they help illustrate the issue.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "✨ Feature request"
2+
description: Suggest an idea to improve the project
3+
title: "[Feature] <short title>"
4+
labels: ["feature", "enhancement"]
5+
assignees: ["miskler"]
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
**Thank you for helping us grow!**
12+
Please fill out the fields below; mock-ups/screenshots are welcome.
13+
14+
- type: input
15+
id: what
16+
attributes:
17+
label: What do you want to achieve?
18+
placeholder: "e.g. Support dark mode in the web UI"
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: how
24+
attributes:
25+
label: How should it look/work?
26+
description: |
27+
Describe the desired behaviour. Plain text is mandatory; you can drag-and-drop images below if helpful.
28+
render: markdown
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: context
34+
attributes:
35+
label: Additional context / attachments
36+
description: Drag & drop any images or diagrams here.

‎.github/workflows/check-tests.yml‎

Lines changed: 0 additions & 65 deletions
This file was deleted.

‎.github/workflows/publish.yml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: publish
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
target:
7+
description: "Publish target"
8+
required: true
9+
default: "all"
10+
type: choice
11+
options: [docs, package, all]
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write # нужно для PyPI Trusted Publishing (OIDC)
17+
18+
concurrency:
19+
group: publish-${{ github.ref }}
20+
cancel-in-progress: true
21+
22+
jobs:
23+
tests:
24+
name: Run tests (reusable)
25+
uses: ./.github/workflows/tests.yml
26+
with:
27+
python-version: "3.12"
28+
29+
build-docs:
30+
if: ${{ github.event.inputs.target == 'docs' || github.event.inputs.target == 'all' }}
31+
name: Build docs
32+
needs: tests
33+
runs-on: ubuntu-latest
34+
steps:
35+
- uses: actions/checkout@v4
36+
- uses: actions/setup-python@v5
37+
with:
38+
python-version: "3.12"
39+
cache: pip
40+
cache-dependency-path: |
41+
requirements.txt
42+
docs/requirements.txt
43+
pyproject.toml
44+
- name: Install deps
45+
run: |
46+
python -m pip install --upgrade pip
47+
if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
48+
pip install -e ".[dev]" || pip install -e .
49+
pip install sphinx || true
50+
- name: Build docs (prefer `make docs`)
51+
run: |
52+
if make -n docs >/dev/null 2>&1; then
53+
make docs
54+
elif [ -d docs ]; then
55+
make -C docs html || (cd docs && sphinx-build -b html source _build/html)
56+
else
57+
echo "::error::No docs directory and no 'make docs' target"; exit 1
58+
fi
59+
- name: Upload Pages artifact
60+
uses: actions/upload-pages-artifact@v3
61+
with:
62+
path: |
63+
docs/_build/html
64+
_build/html
65+
66+
deploy-docs:
67+
if: ${{ github.event.inputs.target == 'docs' || github.event.inputs.target == 'all' }}
68+
name: Deploy docs to GitHub Pages
69+
needs: build-docs
70+
runs-on: ubuntu-latest
71+
environment:
72+
name: github-pages
73+
url: ${{ steps.deployment.outputs.page_url }}
74+
steps:
75+
- name: Deploy
76+
id: deployment
77+
uses: actions/deploy-pages@v4
78+
79+
pypi:
80+
if: ${{ github.event.inputs.target == 'package' || github.event.inputs.target == 'all' }}
81+
name: Build & publish to PyPI (Trusted Publishing)
82+
needs: tests
83+
runs-on: ubuntu-latest
84+
steps:
85+
- uses: actions/checkout@v4
86+
- uses: actions/setup-python@v5
87+
with:
88+
python-version: "3.12"
89+
cache: pip
90+
- name: Build artifacts (PEP 517)
91+
run: |
92+
python -m pip install --upgrade pip
93+
pip install build
94+
make build
95+
- name: Publish to PyPI via OIDC
96+
uses: pypa/gh-action-pypi-publish@release/v1
97+
with:
98+
verbose: true

‎.github/workflows/python-publish.yml‎

Lines changed: 0 additions & 73 deletions
This file was deleted.

0 commit comments

Comments
 (0)