Skip to content

Commit dd1b536

Browse files
authored
Integrate SlangPy docs into RTD site (#86)
This replaces the external links to the SlangPy User Guide in the readthedocs index file with references to the internal copy in the submodule. Also adds explicit include matching for the docs, to avoid wasting time building HTML files for docs that do not belong on the readthedocs site.
1 parent 198bf65 commit dd1b536

File tree

4 files changed

+16
-3
lines changed

4 files changed

+16
-3
lines changed

docs/__static/theme_overrides.css renamed to docs/_static/theme_overrides.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ https://github.com/readthedocs/sphinx_rtd_theme/issues/1301
2626
*/
2727
.py.property {
2828
display: block !important;
29-
}
29+
}
File renamed without changes.

docs/conf.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,19 @@ def setup(app):
6363
intersphinx_disabled_domains = ['std']
6464

6565
templates_path = ['_templates']
66-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'index.md']
66+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'index.md',
67+
'external/slang/docs/stdlib-doc.md',
68+
'external/slang/external',
69+
]
70+
include_patterns = ['index.rst', '*.md',
71+
"external/slang/docs/user-guide/*.md",
72+
"external/stdlib-reference/index.md",
73+
"external/stdlib-reference/attributes/**",
74+
"external/stdlib-reference/global-decls/**",
75+
"external/stdlib-reference/interface/**",
76+
"external/stdlib-reference/types/**",
77+
"external/slangpy/docs/**",
78+
]
6779

6880
# Configure myst-parser for markdown files
6981
myst_enable_extensions = [
@@ -83,6 +95,7 @@ def setup(app):
8395

8496
html_theme = "furo"
8597
html_title = "Slang Documentation"
98+
html_static_path = ['_static']
8699
html_css_files = ["theme_overrides.css"]
87100
html_theme_options = {
88101
"light_css_variables": {

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Slang Documentation
99
User Guide <https://shader-slang.org/slang/user-guide/>
1010
Standard Modules Reference <external/stdlib-reference/index>
1111
Language Spec <https://github.com/shader-slang/spec>
12-
SlangPy User Guide <https://slangpy.shader-slang.org/en/latest/>
12+
SlangPy User Guide <external/slangpy/docs/index.rst>
1313
Feature Matureness <feature_matureness>
1414
Command Line Reference <https://github.com/shader-slang/slang/blob/master/docs/command-line-slangc-reference.md>
1515
Frequently Asked Questions <faq>

0 commit comments

Comments
 (0)