Skip to content
This repository was archived by the owner on Jun 9, 2023. It is now read-only.

Commit f21ac76

Browse files
Documentation Fix
1 parent afb2681 commit f21ac76

2 files changed

Lines changed: 12 additions & 9 deletions

File tree

.readthedocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# Read the Docs configuration file
23
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
34

@@ -9,12 +10,12 @@ sphinx:
910
configuration: docs/conf.py
1011

1112
build:
12-
image: latest # For python 3.6
13+
image: latest # For python 3.7
1314

1415
# Optionally build your docs in additional formats such as PDF and ePub
1516
formats: all
1617

1718
python:
1819
version: 3.7
1920
install:
20-
- requirements: docs/requirements.txt
21+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@
1717
# If extensions (or modules to document with autodoc) are in another directory,
1818
# add these directories to sys.path here. If the directory is relative to the
1919
# documentation root, use os.path.abspath to make it absolute, like shown here.
20-
# sys.path.append(os.path.abspath(<path>))
21-
sys.path.append(os.path.abspath('../examples/'))
22-
sys.path.append(os.path.abspath('../nvtx_plugins/python'))
23-
24-
import nvtx.plugins.tf
25-
from nvtx.plugins.tf.package_info import __version__
2620

21+
sys.path.insert(0, os.path.abspath("../")) # Important
22+
sys.path.insert(0, os.path.abspath(os.path.join("..", "nvtx_plugins"))) # Important
23+
sys.path.insert(0, os.path.abspath(os.path.join("..", "nvtx_plugins", "python"))) # Important
24+
sys.path.insert(0, os.path.abspath(os.path.join("..", "nvtx_plugins", "python", "nvtx"))) # Important
25+
sys.path.insert(0, os.path.abspath(os.path.join("..", "nvtx_plugins", "python", "nvtx", "plugins"))) # Important
26+
sys.path.insert(0, os.path.abspath(os.path.join("..", "nvtx_plugins", "python", "nvtx", "plugins", "tf"))) # Important
2727

2828
# -- General configuration -----------------------------------------------------
2929

@@ -81,7 +81,9 @@
8181
# The version info for the project you're documenting, acts as replacement for
8282
# |version| and |release|, also used in various other places throughout the
8383
# built documents.
84-
#
84+
85+
from package_info import __version__
86+
8587
# The short X.Y version.
8688
version = __version__
8789

0 commit comments

Comments
 (0)