Skip to content

Commit 3e739b9

Browse files
d4l3kfacebook-github-bot
authored andcommitted
torchx/docs: improve Meta specific documentation (#531)
Summary: Pull Request resolved: #531 This adds Meta specific documentation for schedulers/pipelines/named_resources and hides the banner for internal builds. Reviewed By: kurman Differential Revision: D37298737 fbshipit-source-id: c00a08b8a81a22089bdc82b734c869948add6826
1 parent 07768cd commit 3e739b9

File tree

3 files changed

+25
-7
lines changed

3 files changed

+25
-7
lines changed

docs/source/_templates/layout.html

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@
99
{% endblock %}
1010

1111
{%- block extrabody %}
12-
<div id="redirect-banner" style="display: none">
13-
<p>
14-
This is the public documentation. There's an internal wiki with extra
15-
information for Meta employees at
16-
<a href="https://fburl.com/torchx">https://fburl.com/torchx</a>
17-
</p>
18-
</div>
12+
{% if not fbcode %}
13+
<div id="redirect-banner" style="display: none">
14+
<p>
15+
This is the public documentation. There's an internal wiki with extra
16+
information for Meta employees at
17+
<a href="https://fburl.com/torchx">https://fburl.com/torchx</a>
18+
</p>
19+
</div>
20+
{% endif %}
1921
{%- endblock %}
2022

2123
{%- block content %}

docs/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@
7474
if FBCODE:
7575
nbsphinx_execute = "never"
7676

77+
html_context = {"fbcode": FBCODE}
78+
7779
# coverage options
7880

7981
coverage_ignore_modules = [

docs/source/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,14 @@ Documentation
4646
advanced
4747
custom_components.md
4848

49+
.. fbcode::
50+
51+
.. toctree::
52+
:maxdepth: 1
53+
:caption: Usage (Meta)
54+
55+
fb/named_resources
56+
4957

5058
Works With
5159
---------------
@@ -79,7 +87,13 @@ Works With
7987
pipelines/kfp
8088
pipelines/airflow.md
8189

90+
.. fbcode::
91+
92+
.. toctree::
93+
:maxdepth: 1
94+
:caption: Pipelines (Meta)
8295

96+
pipelines/fb/flow
8397

8498

8599
Examples

0 commit comments

Comments
 (0)