Skip to content

Commit d7287ed

Browse files
committed
Rework documentation and build it in the Pages workflow
- New pages: getting started, visualization (WPF), AI coding assistants - Complete, compilable code examples included from Easy2SimDocs/examples - Add llms.txt and llms-full.txt for LLM consumption - Fix mkdocs.yml: re-enable search plugin, set real site_url, add repo link - Remove committed build output (site/, public/) and gitignore it - Replace static.yml with a workflow that builds the docs from source - Exclude Easy2SimDocs examples from the library compile glob
1 parent 5d913b4 commit d7287ed

136 files changed

Lines changed: 2631 additions & 19793 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.
Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,35 @@ jobs:
3131
steps:
3232
- name: Checkout
3333
uses: actions/checkout@v4
34+
35+
# Python 3.11 is required because requirements.txt pins PyYAML==6.0.1,
36+
# which has no wheels for Python 3.12+
37+
- name: Setup Python
38+
uses: actions/setup-python@v5
39+
with:
40+
python-version: "3.11"
41+
42+
- name: Install dependencies
43+
run: pip install -r ./Easy2Sim/Easy2SimDocs/requirements.txt
44+
45+
# Regenerate llms-full.txt so it always matches the current docs
46+
- name: Generate llms-full.txt
47+
run: python generate_llms_full.py
48+
working-directory: ./Easy2Sim/Easy2SimDocs
49+
50+
# Build the documentation from source - no committed site/ output needed
51+
- name: Build documentation
52+
run: mkdocs build
53+
working-directory: ./Easy2Sim/Easy2SimDocs
54+
3455
- name: Setup Pages
3556
uses: actions/configure-pages@v4
57+
3658
- name: Upload artifact
3759
uses: actions/upload-pages-artifact@v3
3860
with:
39-
# Upload entire repository
4061
path: './Easy2Sim/Easy2SimDocs/site'
62+
4163
- name: Deploy to GitHub Pages
4264
id: deployment
4365
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)