Skip to content

Fix toctree hierarchy for chipflow-lib documentation #18

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.

Sign up for GitHub

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

Open
robtaylor wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix toctree hierarchy for chipflow-lib documentation #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ docs/source/*
!docs/source/configurator/
!docs/source/index.rst
!docs/source/support.rst
!docs/source/platform-api.rst
!docs/source/tutorial-intro-chipflow-platform.rst

# Misc
Expand Down
5 changes: 3 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
# copy in the doc sources from our repos
repo_list = copy_docs(repos)

# add our repos to path
# add our repos to path for autodoc to import modules
for r in repo_list:
print(f"copy_docs: Adding {str(r)} to sys.path")
sys.path.append(str(r))
Expand All @@ -35,7 +35,7 @@
.. toctree::
:maxdepth: 3

chipflow-lib/autoapi/chipflow/index
/chipflow-lib/autoapi/chipflow/index
""")

# Update chipflow-lib/index.rst to point to the platform-api.rst outside chipflow-lib/
Expand Down Expand Up @@ -74,6 +74,7 @@
'sphinx_design',
]


rst_prolog = """
.. role:: amaranth

Expand Down
Loading
Loading