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.

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

Jump to bottom

Update hyperlinks in doc_guidelines.rst and docbuild.rst #212

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Update hyperlinks in doc_guidelines.rst and docbuild.rst #212

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
2 changes: 1 addition & 1 deletion developer-guides/doc_guidelines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ Internal Cross-Reference Linking
for instructions on deploying DocSum into Kubernetes on Xeon & Gaudi.

That reference would be rendered into a reference to the
https://opea-project.github.io/GenAIInfra/helm-charts/docsum/README.html
https://opea-project.github.io/latest/GenAIInfra/helm-charts/docsum/README.html
document within the github.io website.

Markdown supports linking to a reST document by using the Myst syntax that
Expand Down
6 changes: 3 additions & 3 deletions developer-guides/docbuild.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ Depending on your Linux version, install the needed tools.
to maintain your Python environment from being changed by other work on your
computer.

.. _Python virtual environment: https://https://docs.python.org/3/library/venv.html
.. _Python virtual environment: https://docs.python.org/3/library/venv.html

For Ubuntu, use:

Expand Down Expand Up @@ -462,6 +462,6 @@ the OPEA project. You can see complex examples in other open source projects
using this filtering script, such as pattern files in
`Project ACRN .known-issues <https://github.com/projectacrn/acrn-hypervisor/tree/master/doc/.known-issues>`_.

.. _reStructuredText: https://sphinx-doc.org/rest.html
.. _reStructuredText: https://www.sphinx-doc.org/rest.html
.. _markdown: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
.. _Sphinx: https://sphinx-doc.org/
.. _Sphinx: https://www.sphinx-doc.org/