Skip to content

[Doc] Group examples into categories #11782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
youkaichao merged 21 commits into from
Jan 8, 2025
Merged

[Doc] Group examples into categories #11782

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
50f9d3a
Ignore all files in `docs/source/getting_started/examples`
hmellor Jan 6, 2025
c163f89
Fix skipped heading level in prometheus/grafana tutorial
hmellor Jan 6, 2025
5936229
Fix code block hinting in FP8 tutorial
hmellor Jan 6, 2025
ff4504b
Add colon_fence and sphinx-togglebutton
hmellor Jan 6, 2025
008e69a
Update `generate_examples.py`
hmellor Jan 6, 2025
a72bff3
Add missing OpenAI batch example
hmellor Jan 6, 2025
929adac
Make typing Python 3.8 compatible for RTD
hmellor Jan 6, 2025
5c57a53
`Example source` -> `Example materials`
hmellor Jan 6, 2025
f0025d8
Make linter happy
hmellor Jan 6, 2025
ea22d7a
Delete md template
hmellor Jan 6, 2025
6538bd8
Fix error with `chart-helm`
hmellor Jan 6, 2025
b01b7c8
Revert "Make typing Python 3.8 compatible for RTD"
hmellor Jan 6, 2025
328f3e6
Make Python 3.12 linter happy
hmellor Jan 6, 2025
71ce031
Split mixed example
hmellor Jan 7, 2025
92d6abf
Categorise based on directory
hmellor Jan 7, 2025
3853007
Make linter happy
hmellor Jan 7, 2025
6c852a8
syntax error
hmellor Jan 7, 2025
141bfbc
Put categorised examples first
hmellor Jan 7, 2025
31972ea
Make `make clean` clear the generated examples
hmellor Jan 7, 2025
960a017
fix case where SOURCEDIR contains whitespace
hmellor Jan 7, 2025
12482c1
Make sure index pages are sorted alphabetically
hmellor Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Put categorised examples first 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
  • Loading branch information
@hmellor
hmellor committed Jan 7, 2025
commit 141bfbcb2d6a0e14ac6433ad0a6d32bf2cffe2c4
2 changes: 1 addition & 1 deletion docs/source/generate_examples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ def generate_examples():
# Generate the index files
for category_index in category_indices.values():
if category_index.documents:
examples_index.documents.append(category_index.path.name)
examples_index.documents.insert(0, category_index.path.name)
with open(category_index.path, "w+") as f:
f.write(category_index.generate())

Expand Down