Skip to content

Commit

Permalink
Merge pull request PaddlePaddle#6 from NHZlX/add_trt_doc
Browse files Browse the repository at this point in the history
Add the api doc
  • Loading branch information
NHZlX committed May 14, 2020
2 parents a29b10e + 2fc71f7 commit 981f2ea
Show file tree
Hide file tree
Showing 19 changed files with 2,355 additions and 813 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
*.DS_Store
._*
docs/_build/
docs/api/
docs/doxyoutput/
43 changes: 43 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,46 @@

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

extensions = [
# there may be others here already, e.g. 'sphinx.ext.mathjax'
'breathe',
'exhale'
]

# Setup the breathe extension
breathe_projects = {
"My Project": "./doxyoutput/xml"
}
breathe_default_project = "My Project"

# Setup the exhale extension
exhale_args = {
# These arguments are required
"containmentFolder": "./api",
"rootFileName": "library_root.rst",
"rootFileTitle": "Library API",
"doxygenStripFromPath": "..",
# Suggested optional arguments
"createTreeView": True,
# TIP: if using the sphinx-bootstrap-theme, you need
# "treeViewIsBootstrap": True,
"exhaleExecutesDoxygen": True,
"exhaleDoxygenStdin": "INPUT = paddle_include_file"
}

# Tell sphinx what the primary language being documented is.
primary_domain = 'cpp'

# Tell sphinx what the pygments highlight language should be.
highlight_language = 'cpp'

import os

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
#html_theme = "alabaster"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
5 changes: 2 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ Welcome to Paddle-Inference's documentation!

tools/visual
tools/x2paddle


.. toctree::
:maxdepth: 1
Expand All @@ -48,10 +47,10 @@ Welcome to Paddle-Inference's documentation!
benchmark/benchmark

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: API文档

api_reference/cxx_api_doc
api/library_root

.. toctree::
:maxdepth: 1
Expand Down
175 changes: 0 additions & 175 deletions docs/introduction/quick_start.md

This file was deleted.

Loading

0 comments on commit 981f2ea

Please sign in to comment.