Skip to content
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.

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

Add Documentation from Additional Repositories to nvidia.docs.com #7046

Merged
merged 54 commits into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
8629f81
Add client and python_backend docs to Toc.
yinggeh Mar 5, 2024
1c6b22d
Server and Client repo documented together
indrajit96 Mar 8, 2024
b276c42
Logging to /tmp/docs.log added
indrajit96 Mar 9, 2024
89bc127
Dockerfile fix
indrajit96 Mar 9, 2024
ec38273
Update toc struture and order
yinggeh Mar 11, 2024
303660b
Build.py changes removed added args to generate_docs.py
indrajit96 Mar 13, 2024
0a1bf30
Merge branch 'DLIS-6234-build-triton-docs' of github.com:triton-infer…
indrajit96 Mar 13, 2024
f5b9b0f
Update Generate docs
indrajit96 Mar 14, 2024
ace21b4
Replace embedded Github URL with relative file path and revert build.py
yinggeh Mar 15, 2024
57f8fc9
Replace embedded directory paths with URLs.
yinggeh Mar 16, 2024
c67ab44
Adding structure reference to the new document
yinggeh Mar 19, 2024
235c0d3
save the work
yinggeh Mar 20, 2024
24944fa
Optimized the logic and checkd the replacements.
yinggeh Mar 21, 2024
a2ea26b
Optimized the logic and checkd the replacements.
yinggeh Mar 21, 2024
93699f9
Merge branch 'DLIS-6234-build-triton-docs' of github.com:triton-infer…
indrajit96 Mar 21, 2024
4df3422
Fix missing sections after url.
yinggeh Mar 21, 2024
4987c09
Remove --it
indrajit96 Mar 21, 2024
4e42eb2
Merge branch 'DLIS-6234-build-triton-docs' of github.com:triton-infer…
indrajit96 Mar 21, 2024
49ef5d1
Add a flag
indrajit96 Mar 21, 2024
b4ce3cd
Add a flag
indrajit96 Mar 21, 2024
4d35be7
Add a flag
indrajit96 Mar 21, 2024
09bc15b
Rewrite docker commands
indrajit96 Mar 21, 2024
cf6966b
Cleanup
indrajit96 Mar 21, 2024
478faee
Preprocess the server repo.
yinggeh Mar 22, 2024
2d1a623
Merge branch 'DLIS-6234-build-triton-docs' of https://github.com/trit…
yinggeh Mar 22, 2024
ace485f
Merge branch 'main' of https://github.com/triton-inference-server/ser…
yinggeh Mar 22, 2024
774b412
Reorganize toc in contents.md
yinggeh Mar 22, 2024
1ae5455
Minor changes
yinggeh Mar 23, 2024
4b176b3
Move generate_docs.py to docs/.
yinggeh Mar 23, 2024
152b7f0
cd to server repo dir after running the script.
yinggeh Mar 23, 2024
ca05658
Simplify logic
yinggeh Mar 25, 2024
12aea00
Fix clean up code
yinggeh Mar 25, 2024
28cbc45
Merge branch 'main' of https://github.com/triton-inference-server/ser…
yinggeh Mar 25, 2024
667d01a
Exclude files specified in conf.py.
yinggeh Mar 25, 2024
b386a92
Run generate_docs.py in a container.
yinggeh Mar 25, 2024
4d23c6d
fix
yinggeh Mar 26, 2024
2114b51
Revert contents.md
yinggeh Mar 26, 2024
f4e77c0
import exclude_patterns from conf.py
yinggeh Mar 26, 2024
3de3f52
Improve readability.
yinggeh Mar 26, 2024
4882bb3
Fix "find" command.
yinggeh Mar 26, 2024
1905a3f
Fix
yinggeh Mar 26, 2024
ebb1eb0
PR Cleanup
indrajit96 Mar 26, 2024
aed88e4
fix bug
yinggeh Mar 26, 2024
70438c4
Merge branch 'DLIS-6234-build-triton-docs' of https://github.com/trit…
yinggeh Mar 26, 2024
c28a22a
test
yinggeh Mar 26, 2024
e61a81a
Fix
yinggeh Mar 27, 2024
3791a83
Remove unused module and variable.
yinggeh Apr 3, 2024
15742f6
Fix Sphinx warning.
yinggeh Apr 4, 2024
3f5267d
Use compiled regex to improve efficiency.
yinggeh Apr 4, 2024
a4f20a2
improve code
yinggeh Apr 5, 2024
5241bc8
Fix
yinggeh Apr 5, 2024
350147c
improve code
yinggeh Apr 5, 2024
c73d5fb
update docs
yinggeh Apr 5, 2024
351981e
Merge branch 'main' of https://github.com/triton-inference-server/ser…
yinggeh Apr 5, 2024
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
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"sphinx_sitemap",
]

suppress_warnings = ["myst.domains", "ref.ref"]
suppress_warnings = ["myst.domains", "ref.ref", "myst.header"]

numfig = True

Expand Down Expand Up @@ -105,7 +105,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["README.md"]
exclude_patterns = ["README.md", "examples/README.md", "user_guide/perf_analyzer.md"]

# -- Options for HTML output -------------------------------------------------

Expand Down Expand Up @@ -183,7 +183,7 @@ def ultimateReplace(app, docname, source):
# bibtex_default_style = "plain"

### We currently use Myst: https://myst-nb.readthedocs.io/en/latest/use/execute.html
jupyter_execute_notebooks = "off" # Global execution disable
nb_execution_mode = "off" # Global execution disable
# execution_excludepatterns = ['tutorials/tts-python-basics.ipynb'] # Individual notebook disable


Expand Down
48 changes: 46 additions & 2 deletions docs/contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ user_guide/optimization
user_guide/ragged_batching
user_guide/rate_limiter
user_guide/model_analyzer
user_guide/perf_analyzer
user_guide/model_management
user_guide/custom_operations
user_guide/decoupled_models
Expand All @@ -71,7 +70,7 @@ user_guide/faq
:maxdepth: 1
:caption: Protocol Guides

protocol/README.md
protocol/README
customization_guide/inference_protocols
protocol/extension_binary_data
protocol/extension_classification
Expand All @@ -84,6 +83,7 @@ protocol/extension_sequence
protocol/extension_shared_memory
protocol/extension_statistics
protocol/extension_trace
protocol/extension_parameters
```

```{toctree}
Expand All @@ -102,3 +102,47 @@ customization_guide/test
examples/jetson/README
examples/jetson/concurrency_and_dynamic_batching/README
```

```{toctree}
:maxdepth: 1
:caption: Client

client/README
tanmayv25 marked this conversation as resolved.
Show resolved Hide resolved
client/src/java/README
client/src/grpc_generated/go/README
client/src/grpc_generated/javascript/README
client/src/grpc_generated/java/README
```

```{toctree}
:maxdepth: 1
:caption: Performance Analyzer

client/src/c++/perf_analyzer/README
client/src/c++/perf_analyzer/docs/README
client/src/c++/perf_analyzer/docs/install
client/src/c++/perf_analyzer/docs/quick_start
client/src/c++/perf_analyzer/docs/cli
client/src/c++/perf_analyzer/docs/inference_load_modes
client/src/c++/perf_analyzer/docs/input_data
client/src/c++/perf_analyzer/docs/measurements_metrics
client/src/c++/perf_analyzer/docs/benchmarking
client/src/c++/perf_analyzer/genai-perf/README
client/src/c++/perf_analyzer/genai-perf/examples/tutorial
```

```{toctree}
:maxdepth: 1
:caption: Python Backend

python_backend/README
python_backend/inferentia/README
python_backend/examples/auto_complete/README
python_backend/examples/bls/README
python_backend/examples/bls_decoupled/README
python_backend/examples/custom_metrics/README
python_backend/examples/decoupled/README
python_backend/examples/instance_kind/README
python_backend/examples/jax/README
python_backend/examples/preprocessing/README
```
Loading
Loading