Skip to content

Commit b6d124c

Browse files
RichardFrangenbergRichardFrangenberg
committed
autodoc
1 parent 5a7da37 commit b6d124c

File tree

13 files changed

+231
-0
lines changed

13 files changed

+231
-0
lines changed

‎.github/workflows/documentation.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: documentation
2+
3+
on: [push, pull_request, workflow_dispatch]
4+
5+
permissions:
6+
contents: write
7+
8+
jobs:
9+
docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: actions/setup-python@v4
14+
with:
15+
python-version: 3.9
16+
17+
- name: Install dependencies
18+
run: |
19+
pip install sphinx sphinx_book_theme myst_parser PySide2
20+
21+
- name: Sphinx build
22+
env:
23+
PRISM_NO_LIBS: "1"
24+
run: |
25+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/core Prism/Scripts/ Prism/Scripts//UserInterfacesPrism Prism/Scripts/OSX_Post-Install* Prism/Scripts/OSX_Pre-Install*
26+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/3dsMax Prism/Plugins/Apps/3dsMax/Scripts Prism/Plugins/Apps/3dsMax/Scripts/*_init* Prism/Plugins/Apps/3dsMax/Scripts/*_Variables*
27+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/Blender Prism/Plugins/Apps/Blender/Scripts Prism/Plugins/Apps/Blender/Scripts/*_init* Prism/Plugins/Apps/Blender/Scripts/*_Variables*
28+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/Houdini Prism/Plugins/Apps/Houdini/Scripts Prism/Plugins/Apps/Houdini/Scripts/*_init* Prism/Plugins/Apps/Houdini/Scripts/*_Variables*
29+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/Maya Prism/Plugins/Apps/Maya/Scripts Prism/Plugins/Apps/Maya/Scripts/*_init* Prism/Plugins/Apps/Maya/Scripts/*_Variables*
30+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/Nuke Prism/Plugins/Apps/Nuke/Scripts Prism/Plugins/Apps/Nuke/Scripts/*_init* Prism/Plugins/Apps/Nuke/Scripts/*_Variables*
31+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/Photoshop Prism/Plugins/Apps/Photoshop/Scripts Prism/Plugins/Apps/Photoshop/Scripts/*_init* Prism/Plugins/Apps/Photoshop/Scripts/*_Variables* Prism/Plugins/Apps/Photoshop/Scripts/*_MenuTools*
32+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/PureRef Prism/Plugins/Apps/PureRef/Scripts Prism/Plugins/Apps/PureRef/Scripts/*_init* Prism/Plugins/Apps/PureRef/Scripts/*_Variables*
33+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/Deadline Prism/Plugins/RenderfarmManagers/Deadline/Scripts Prism/Plugins/RenderfarmManagers/Deadline/Scripts/*_init* Prism/Plugins/RenderfarmManagers/Deadline/Scripts/*_Variables*
34+
sphinx-apidoc --no-toc --module-first -o doc/autodoc/plugins/Standalone Prism/Plugins/Apps/Standalone/Scripts Prism/Plugins/Apps/Standalone/Scripts/*_init* Prism/Plugins/Apps/Standalone/Scripts/*_Variables*
35+
sphinx-build doc _build -b dirhtml
36+
37+
- name: Deploy to GitHub Pages
38+
uses: peaceiris/actions-gh-pages@v3
39+
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development' }}
40+
with:
41+
publish_branch: gh-pages
42+
github_token: ${{ secrets.GITHUB_TOKEN }}
43+
publish_dir: _build/
44+
force_orphan: true

‎doc/3dsMax.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
3ds Max
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/3dsMax/*

‎doc/Blender.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Blender
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/Blender/*

‎doc/Deadline.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Deadline
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/Deadline/*

‎doc/Houdini.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Houdini
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/Houdini/*

‎doc/Maya.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Maya
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/Maya/*

‎doc/Nuke.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Nuke
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/Nuke/*

‎doc/Photoshop.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Photoshop
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/Photoshop/*

‎doc/PureRef.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Maya
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/PureRef/*

‎doc/Standalone.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Standalone
2+
===================================
3+
4+
.. toctree::
5+
:glob:
6+
:maxdepth: 2
7+
8+
autodoc/plugins/Standalone/*

0 commit comments

Comments
 (0)