chunk_id stringlengths 36 36 | source stringclasses 35
values | source_url stringlengths 0 290 | upstream_license stringclasses 1
value | document_id stringlengths 36 36 | chunk_index int64 0 324k | retrieved_at stringclasses 2
values | chunker_version stringclasses 4
values | content_hash stringlengths 15 64 | content stringlengths 50 44.7k | namespace stringclasses 9
values | source_name stringclasses 35
values | raw_text stringlengths 50 44.7k | cleaned_text stringlengths 50 44.7k | tags stringclasses 49
values | collection_name stringclasses 11
values |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
e747af99-90bd-46e0-b553-0469977c6ffd | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 113 | opea-semantic-v1 | 951957cd3567b01d | reST, you incorporate content from another file using an include directive. Unless options are given, the included file is parsed in the current document's context::
Here is some text in the reST document. | ai_ref_knowledge | OPEA Documentation | reST, you incorporate content from another file using an include directive. Unless options are given, the included file is parsed in the current document's context::
Here is some text in the reST document. | reST, you incorporate content from another file using an include directive. Unless options are given, the included file is parsed in the current document's context::
Here is some text in the reST document. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e81e31aa-6c37-4c71-9dbd-c07c3c20a388 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 175 | opea-semantic-v1 | 3f90d082d9163606 | docs (requirements.txt) setup. Within a tab, you can have most any content *other than a heading* (code-blocks, ordered and unordered lists, pictures, paragraphs, and such).
.. group-tab:: markdown | ai_ref_knowledge | OPEA Documentation | docs (requirements.txt) setup. Within a tab, you can have most any content *other than a heading* (code-blocks, ordered and unordered lists, pictures, paragraphs, and such).
.. group-tab:: markdown | docs (requirements.txt) setup. Within a tab, you can have most any content *other than a heading* (code-blocks, ordered and unordered lists, pictures, paragraphs, and such).
.. group-tab:: markdown | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ec20f51f-66e8-4c81-9d49-0bc45016b9ba | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 65 | opea-semantic-v1 | 0d901635dd570c78 | - body row 1, column 3 * - body row 2, column 1 - body row 2, column 2 - body row 2, column 3
The ``:widths:`` parameter lets you define relative column widths. The
default is equal column widths. If you have a three-column table and you
want the first column to be half as wide as the other two equal-width
columns, ... | ai_ref_knowledge | OPEA Documentation | - body row 1, column 3 * - body row 2, column 1 - body row 2, column 2 - body row 2, column 3
The ``:widths:`` parameter lets you define relative column widths. The
default is equal column widths. If you have a three-column table and you
want the first column to be half as wide as the other two equal-width
columns, ... | - body row 1, column 3 * - body row 2, column 1 - body row 2, column 2 - body row 2, column 3
The ``:widths:`` parameter lets you define relative column widths. The
default is equal column widths. If you have a three-column table and you
want the first column to be half as wide as the other two equal-width
columns, ... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ec32f435-ce64-4a3a-a78a-aaf5704bcaf5 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 172 | opea-semantic-v1 | 66040c352ab9e0c0 | Oranges are orange.
Tabs can also be grouped so that changing the current tab in one area
changes all tabs with the same name throughout the page. For example: | ai_ref_knowledge | OPEA Documentation | Oranges are orange.
Tabs can also be grouped so that changing the current tab in one area
changes all tabs with the same name throughout the page. For example: | Oranges are orange.
Tabs can also be grouped so that changing the current tab in one area
changes all tabs with the same name throughout the page. For example: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ecee9596-6959-4c20-ad4a-5ddd3fa80c26 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 174 | opea-semantic-v1 | 104a6fcf37731422 | Windows Line 2
In this latter case, we're using a ``.. group-tab::`` directive instead of
a ``.. tab::`` directive. Under the hood, we're using the `sphinx-tabs
<https://github.com/djungelorm/sphinx-tabs>`_ extension that's included
in the OPEA docs (requirements.txt) setup. Within a tab, you can have most
any cont... | ai_ref_knowledge | OPEA Documentation | Windows Line 2
In this latter case, we're using a ``.. group-tab::`` directive instead of
a ``.. tab::`` directive. Under the hood, we're using the `sphinx-tabs
<https://github.com/djungelorm/sphinx-tabs>`_ extension that's included
in the OPEA docs (requirements.txt) setup. Within a tab, you can have most
any cont... | Windows Line 2
In this latter case, we're using a ``.. group-tab::`` directive instead of
a ``.. tab::`` directive. Under the hood, we're using the `sphinx-tabs
<https://github.com/djungelorm/sphinx-tabs>`_ extension that's included
in the OPEA docs (requirements.txt) setup. Within a tab, you can have most
any cont... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ed1b9abd-d0b3-4e34-9a49-57f7dc5f5e01 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 169 | opea-semantic-v1 | f84506d012e4e328 | LR; A--> B & C & D; B--> A & E; C--> A & E; D--> A & E; E--> B & C & D;
See the `Mermaid User Guide <https://mermaid.js.org/intro/getting-started.html>`_ for more
information. | ai_ref_knowledge | OPEA Documentation | LR; A--> B & C & D; B--> A & E; C--> A & E; D--> A & E; E--> B & C & D;
See the `Mermaid User Guide <https://mermaid.js.org/intro/getting-started.html>`_ for more
information. | LR; A--> B & C & D; B--> A & E; C--> A & E; D--> A & E; E--> B & C & D;
See the `Mermaid User Guide <https://mermaid.js.org/intro/getting-started.html>`_ for more
information. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ed62d040-b648-4eef-be9d-0ba0be79e53c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 52 | opea-semantic-v1 | 30351cd4a9b265cc | .. rst-class:: rst-columns
* A list of
* short items
* that should be
* displayed
* horizontally
* so it doesn't
* use up so much
* space on
* the page | ai_ref_knowledge | OPEA Documentation | .. rst-class:: rst-columns
* A list of
* short items
* that should be
* displayed
* horizontally
* so it doesn't
* use up so much
* space on
* the page | .. rst-class:: rst-columns
* A list of
* short items
* that should be
* displayed
* horizontally
* so it doesn't
* use up so much
* space on
* the page | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f04554a4-6324-49a5-aa94-102b19b10661 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 43 | opea-semantic-v1 | 74072e1b37de7f67 | It has three items (and uses autonumbering for the rest of the list) #. Here's the third item. Use consistent punctuation on the list number.
#. This is an autonumbered list (default is to use numbers starting
with 1). | ai_ref_knowledge | OPEA Documentation | It has three items (and uses autonumbering for the rest of the list) #. Here's the third item. Use consistent punctuation on the list number.
#. This is an autonumbered list (default is to use numbers starting
with 1). | It has three items (and uses autonumbering for the rest of the list) #. Here's the third item. Use consistent punctuation on the list number.
#. This is an autonumbered list (default is to use numbers starting
with 1). | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f0495ee2-1b62-4831-9fea-0b09b1f4e465 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 162 | opea-semantic-v1 | 6d0cf0e37d5de195 | We've also included an extension providing ``mermaid`` support that also enables that text description language to render drawings using::
.. mermaid:: | ai_ref_knowledge | OPEA Documentation | We've also included an extension providing ``mermaid`` support that also enables that text description language to render drawings using::
.. mermaid:: | We've also included an extension providing ``mermaid`` support that also enables that text description language to render drawings using::
.. mermaid:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f06e17b3-76db-467f-8f94-55fe43931692 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 7 | opea-semantic-v1 | 34580e943e9cb3b2 | parser provides extensions to markdown that integrated well with Sphinx, so we use this as a bridge for the markdown content within the OPEA project.
Within the OPEA documentation, we use both markdown and reST files for the
documentation "leaves". We rely on reST for the documentation organization trunk and
branches, ... | ai_ref_knowledge | OPEA Documentation | parser provides extensions to markdown that integrated well with Sphinx, so we use this as a bridge for the markdown content within the OPEA project.
Within the OPEA documentation, we use both markdown and reST files for the
documentation "leaves". We rely on reST for the documentation organization trunk and
branches, ... | parser provides extensions to markdown that integrated well with Sphinx, so we use this as a bridge for the markdown content within the OPEA project.
Within the OPEA documentation, we use both markdown and reST files for the
documentation "leaves". We rely on reST for the documentation organization trunk and
branches, ... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f238aa1d-5600-4e80-bcae-0768da0cba23 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 96 | opea-semantic-v1 | ef92f9aba6e5017f | linking to other documents using the ``[link text](link path)``. For example to link to a document within the same repo, a relative path is used::
Refer to [Kubernetes deployment](./kubernetes/intel/README_gmc.md) | ai_ref_knowledge | OPEA Documentation | linking to other documents using the ``[link text](link path)``. For example to link to a document within the same repo, a relative path is used::
Refer to [Kubernetes deployment](./kubernetes/intel/README_gmc.md) | linking to other documents using the ``[link text](link path)``. For example to link to a document within the same repo, a relative path is used::
Refer to [Kubernetes deployment](./kubernetes/intel/README_gmc.md) | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f349276e-6a94-482a-804c-fd705bc9f3eb | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 85 | opea-semantic-v1 | 38fe3a6362aec0b3 | .. _my label name:
Note the leading underscore indicating an **inbound link**. The content
immediately following this label is the target for a ``:ref:`my label name```
reference from anywhere within the documentation set. The label **must** be
added immediately before a heading so that there's a natural phrase to s... | ai_ref_knowledge | OPEA Documentation | .. _my label name:
Note the leading underscore indicating an **inbound link**. The content
immediately following this label is the target for a ``:ref:`my label name```
reference from anywhere within the documentation set. The label **must** be
added immediately before a heading so that there's a natural phrase to s... | .. _my label name:
Note the leading underscore indicating an **inbound link**. The content
immediately following this label is the target for a ``:ref:`my label name```
reference from anywhere within the documentation set. The label **must** be
added immediately before a heading so that there's a natural phrase to s... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f430f7e7-0ffb-44af-acdc-eaf057b3755f | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 140 | opea-semantic-v1 | 22e4f358ee2a462c | Would display as:
This block of text would be styled with a background
and box, but with no syntax highlighting. | ai_ref_knowledge | OPEA Documentation | Would display as:
This block of text would be styled with a background
and box, but with no syntax highlighting. | Would display as:
This block of text would be styled with a background
and box, but with no syntax highlighting. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f62e2e8e-6b9a-4512-ac51-b886bb46f282 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 23 | opea-semantic-v1 | 533ea8d2b07f1b1e | Some common reST and markdown inline markup samples:
* one asterisk: ``*text*`` for emphasis (*italics*),
* two asterisks: ``**text**`` for strong emphasis (**boldface**) | ai_ref_knowledge | OPEA Documentation | Some common reST and markdown inline markup samples:
* one asterisk: ``*text*`` for emphasis (*italics*),
* two asterisks: ``**text**`` for strong emphasis (**boldface**) | Some common reST and markdown inline markup samples:
* one asterisk: ``*text*`` for emphasis (*italics*),
* two asterisks: ``**text**`` for strong emphasis (**boldface**) | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f7f1c5c1-a218-4f41-a586-9c6a297482b7 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 79 | opea-semantic-v1 | ee69fcd23691970e | to the "blob" file in the GitHub repo as displayed by GitHub. There's also an ``:docs_raw:`developer-guides/doc_guidelines.rst``` role that will link to the "raw" uninterpreted file,
to see the difference. | ai_ref_knowledge | OPEA Documentation | to the "blob" file in the GitHub repo as displayed by GitHub. There's also an ``:docs_raw:`developer-guides/doc_guidelines.rst``` role that will link to the "raw" uninterpreted file,
to see the difference. | to the "blob" file in the GitHub repo as displayed by GitHub. There's also an ``:docs_raw:`developer-guides/doc_guidelines.rst``` role that will link to the "raw" uninterpreted file,
to see the difference. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f9672235-0e23-47d1-a546-49f20cebc973 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 139 | opea-semantic-v1 | 2e8228e24025083a | This block of text would be styled with a background and box, but with no syntax highlighting.
Would display as: | ai_ref_knowledge | OPEA Documentation | This block of text would be styled with a background and box, but with no syntax highlighting.
Would display as: | This block of text would be styled with a background and box, but with no syntax highlighting.
Would display as: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
fa247de0-0005-4865-9658-199d761592ff | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 176 | opea-semantic-v1 | 054033285bc94a09 | .. group-tab:: markdown
While markdown does not have native support for tabbed alternatives, we do
support this in the OPEA markdown documentation with the Myst Parser
extension:: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: markdown
While markdown does not have native support for tabbed alternatives, we do
support this in the OPEA markdown documentation with the Myst Parser
extension:: | .. group-tab:: markdown
While markdown does not have native support for tabbed alternatives, we do
support this in the OPEA markdown documentation with the Myst Parser
extension:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
fa281636-ff33-4b9e-84e9-d95df184b376 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 33 | opea-semantic-v1 | f73d91d2fe2f7564 | a list so in the generated HTML, the content looks like it's part of that list and not a new paragraph outside of that list.
For example, compare this: | ai_ref_knowledge | OPEA Documentation | a list so in the generated HTML, the content looks like it's part of that list and not a new paragraph outside of that list.
For example, compare this: | a list so in the generated HTML, the content looks like it's part of that list and not a new paragraph outside of that list.
For example, compare this: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
facd8437-43d5-440f-beaf-615e66d0762d | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 144 | opea-semantic-v1 | 10fb6d75bf742fd8 | markdown, fenced code blocks are used to define code blocks. Use three backticks ``````` on the lines before and after the code block, for example:
{
"firstName": "John",
"lastName": "Smith",
"age": 25
} | ai_ref_knowledge | OPEA Documentation | markdown, fenced code blocks are used to define code blocks. Use three backticks ``````` on the lines before and after the code block, for example:
{
"firstName": "John",
"lastName": "Smith",
"age": 25
} | markdown, fenced code blocks are used to define code blocks. Use three backticks ``````` on the lines before and after the code block, for example:
{
"firstName": "John",
"lastName": "Smith",
"age": 25
} | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
fd6934a1-09ac-474e-9564-b4488206fac9 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 148 | opea-semantic-v1 | 8aa75b2aad12106f | are: ``bash``, ``console``, ``none``, ``json``, ``python``, ``markdown``, and ``rest``. See this `complete list of Pygments lexer languages <https://pygments.org/docs/lexers>`_ for more (use the "Short name" shown).
Images
****** | ai_ref_knowledge | OPEA Documentation | are: ``bash``, ``console``, ``none``, ``json``, ``python``, ``markdown``, and ``rest``. See this `complete list of Pygments lexer languages <https://pygments.org/docs/lexers>`_ for more (use the "Short name" shown).
Images
****** | are: ``bash``, ``console``, ``none``, ``json``, ``python``, ``markdown``, and ``rest``. See this `complete list of Pygments lexer languages <https://pygments.org/docs/lexers>`_ for more (use the "Short name" shown).
Images
****** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
fd7c6c32-b24e-4435-9174-04c5c1709605 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 40 | opea-semantic-v1 | a3589e43988bd9b4 | * Here's a second bullet list item
* This is a bulleted list. * It has two items, the second
item and has more than one line of text. Additional lines
are indented to the first character of the
text of the bullet list. | ai_ref_knowledge | OPEA Documentation | * Here's a second bullet list item
* This is a bulleted list. * It has two items, the second
item and has more than one line of text. Additional lines
are indented to the first character of the
text of the bullet list. | * Here's a second bullet list item
* This is a bulleted list. * It has two items, the second
item and has more than one line of text. Additional lines
are indented to the first character of the
text of the bullet list. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
014192bd-4337-431c-9db4-e2f296a0e4ed | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 39 | opea-semantic-v1 | dcd7ed019adb59d6 | will need to open a new terminal for this change to take effect. Adding this to your ``~/.bashrc`` file ensures it is set by default.
And with that you're ready to generate the documentation. | ai_ref_knowledge | OPEA Documentation | will need to open a new terminal for this change to take effect. Adding this to your ``~/.bashrc`` file ensures it is set by default.
And with that you're ready to generate the documentation. | will need to open a new terminal for this change to take effect. Adding this to your ``~/.bashrc`` file ensures it is set by default.
And with that you're ready to generate the documentation. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
0323b57f-7670-4f76-a6a8-63c286fa65ae | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 26 | opea-semantic-v1 | 6cfbd78721609315 | git upstream remote) for the other four repos replacing the docs.git repo name in the previous step with the appropriate repo name in this list:
* ``GenAIComps``
* ``GenAIEval``
* ``GenAIExamples``
* ``GenAIInfra`` | ai_ref_knowledge | OPEA Documentation | git upstream remote) for the other four repos replacing the docs.git repo name in the previous step with the appropriate repo name in this list:
* ``GenAIComps``
* ``GenAIEval``
* ``GenAIExamples``
* ``GenAIInfra`` | git upstream remote) for the other four repos replacing the docs.git repo name in the previous step with the appropriate repo name in this list:
* ``GenAIComps``
* ``GenAIEval``
* ``GenAIExamples``
* ``GenAIInfra`` | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
0b542c8c-17ea-4923-807f-a93c75c7e291 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 71 | opea-semantic-v1 | 29da84d2bf96765d | documentation for a tagged version (e.g., 1.0), check out that version of **all** the component repos, and add some extra flags to the ``make`` commands:
version=1.0
for d in docs GenAIComps GenAIExamples GenAIEval GenAIInfra ; do
cd ~/opea-project/$d
git checkout $version
done | ai_ref_knowledge | OPEA Documentation | documentation for a tagged version (e.g., 1.0), check out that version of **all** the component repos, and add some extra flags to the ``make`` commands:
version=1.0
for d in docs GenAIComps GenAIExamples GenAIEval GenAIInfra ; do
cd ~/opea-project/$d
git checkout $version
done | documentation for a tagged version (e.g., 1.0), check out that version of **all** the component repos, and add some extra flags to the ``make`` commands:
version=1.0
for d in docs GenAIComps GenAIExamples GenAIEval GenAIInfra ; do
cd ~/opea-project/$d
git checkout $version
done | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
0c5ea7be-d167-4c28-80ec-80d76f4a267d | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 53 | opea-semantic-v1 | aedd6bb2dad5725a | make server
Use your web browser to open the URL: ``http://localhost:8000`` and wander
around your local site and view the results of your changes. When
done, press :kbd:`ctrl-C` in your command-prompt window to stop the web server. | ai_ref_knowledge | OPEA Documentation | make server
Use your web browser to open the URL: ``http://localhost:8000`` and wander
around your local site and view the results of your changes. When
done, press :kbd:`ctrl-C` in your command-prompt window to stop the web server. | make server
Use your web browser to open the URL: ``http://localhost:8000`` and wander
around your local site and view the results of your changes. When
done, press :kbd:`ctrl-C` in your command-prompt window to stop the web server. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
15263838-c4d0-45f9-aada-31184f4923b8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 19 | opea-semantic-v1 | 362c94f1145cf4b6 | development computer, and then link that to the upstream repo as well. You'll only need to do this once to set up the folder structure:
#. Use your browser to visit https://github.com/opea-project and do a
fork of the **docs** repo to your personal GitHub account.) | ai_ref_knowledge | OPEA Documentation | development computer, and then link that to the upstream repo as well. You'll only need to do this once to set up the folder structure:
#. Use your browser to visit https://github.com/opea-project and do a
fork of the **docs** repo to your personal GitHub account.) | development computer, and then link that to the upstream repo as well. You'll only need to do this once to set up the folder structure:
#. Use your browser to visit https://github.com/opea-project and do a
fork of the **docs** repo to your personal GitHub account.) | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
1573e112-ac83-4f98-a833-841f115dcfbd | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 22 | opea-semantic-v1 | 7bbae4bda5efa2d1 | cd ~ mkdir opea-project && cd opea-project git clone https://github.com/<github-username>/docs.git
#. For the cloned local repo, tell git about the upstream repo: | ai_ref_knowledge | OPEA Documentation | cd ~ mkdir opea-project && cd opea-project git clone https://github.com/<github-username>/docs.git
#. For the cloned local repo, tell git about the upstream repo: | cd ~ mkdir opea-project && cd opea-project git clone https://github.com/<github-username>/docs.git
#. For the cloned local repo, tell git about the upstream repo: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
18fed7f3-d18b-4700-961b-cd07abd3a61a | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 12 | opea-semantic-v1 | 20b77bde3c0d8db4 | in markdown files to markdown files (.md file extension) are converted to the corresponding generated HTML files by Sphinx using the Myst and sphinx-md extensions.
Set Up the Documentation Working Folders
**************************************** | ai_ref_knowledge | OPEA Documentation | in markdown files to markdown files (.md file extension) are converted to the corresponding generated HTML files by Sphinx using the Myst and sphinx-md extensions.
Set Up the Documentation Working Folders
**************************************** | in markdown files to markdown files (.md file extension) are converted to the corresponding generated HTML files by Sphinx using the Myst and sphinx-md extensions.
Set Up the Documentation Working Folders
**************************************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
19d049de-e9af-4f5a-9553-c7f9e3718ea1 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 62 | opea-semantic-v1 | f1a542b28b1f8abd | You'll need to do a one-time clone of the upstream repo (we publish directly to the upstream repo rather than to a personal forked copy):
cd ~/opea-project
git clone https://github.com/opea-project/opea-project.github.io.git | ai_ref_knowledge | OPEA Documentation | You'll need to do a one-time clone of the upstream repo (we publish directly to the upstream repo rather than to a personal forked copy):
cd ~/opea-project
git clone https://github.com/opea-project/opea-project.github.io.git | You'll need to do a one-time clone of the upstream repo (we publish directly to the upstream repo rather than to a personal forked copy):
cd ~/opea-project
git clone https://github.com/opea-project/opea-project.github.io.git | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
1a37f372-1676-49a6-aa4f-46597eb695a1 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 3 | opea-semantic-v1 | 5016440683bba57e | at https://opea-project.github.io. While working on new content or editing existing content, developers can generate the HTML content locally and view it with a web browser.
You can read details about `markdown`_, `reStructuredText`_, and `Sphinx`_ from
their respective websites. | ai_ref_knowledge | OPEA Documentation | at https://opea-project.github.io. While working on new content or editing existing content, developers can generate the HTML content locally and view it with a web browser.
You can read details about `markdown`_, `reStructuredText`_, and `Sphinx`_ from
their respective websites. | at https://opea-project.github.io. While working on new content or editing existing content, developers can generate the HTML content locally and view it with a web browser.
You can read details about `markdown`_, `reStructuredText`_, and `Sphinx`_ from
their respective websites. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
1e3f219b-1ba0-46be-acd1-ca2273cf550c | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 47 | opea-semantic-v1 | 2a85ac8c7c218897 | Run the Documentation Processors ********************************
The ``docs`` folder (with all the cloned sibling repos) have all the doc source files,
images, extra tools, and ``Makefile`` for generating a local copy of the OPEA
technical documentation. It's best to start with a clean doc-build environment
so use ``m... | ai_ref_knowledge | OPEA Documentation | Run the Documentation Processors ********************************
The ``docs`` folder (with all the cloned sibling repos) have all the doc source files,
images, extra tools, and ``Makefile`` for generating a local copy of the OPEA
technical documentation. It's best to start with a clean doc-build environment
so use ``m... | Run the Documentation Processors ********************************
The ``docs`` folder (with all the cloned sibling repos) have all the doc source files,
images, extra tools, and ``Makefile`` for generating a local copy of the OPEA
technical documentation. It's best to start with a clean doc-build environment
so use ``m... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
20786285-6e9f-497e-8b36-c3f2d2ae8596 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 54 | opea-semantic-v1 | 9087125214cb6919 | wander around your local site and view the results of your changes. When done, press :kbd:`ctrl-C` in your command-prompt window to stop the web server.
If things look good, you'd proceed to using git (``git add .``) to add and commit
(``git commit -s``) your changes, push those changes to your personal forked
repo (``... | ai_ref_knowledge | OPEA Documentation | wander around your local site and view the results of your changes. When done, press :kbd:`ctrl-C` in your command-prompt window to stop the web server.
If things look good, you'd proceed to using git (``git add .``) to add and commit
(``git commit -s``) your changes, push those changes to your personal forked
repo (``... | wander around your local site and view the results of your changes. When done, press :kbd:`ctrl-C` in your command-prompt window to stop the web server.
If things look good, you'd proceed to using git (``git add .``) to add and commit
(``git commit -s``) your changes, push those changes to your personal forked
repo (``... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2181623e-0601-4af0-adac-ed4a2288682d | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 83 | opea-semantic-v1 | b2d4ca26fb4b3d06 | that should be reported. You can modify the filtering by adding or editing a conf file in the ``.known-issues`` folder, following the examples found there.
Multi-line patterns can get rather complex. We're not using any multi-line patterns in
the OPEA project. You can see complex examples in other open source projects
... | ai_ref_knowledge | OPEA Documentation | that should be reported. You can modify the filtering by adding or editing a conf file in the ``.known-issues`` folder, following the examples found there.
Multi-line patterns can get rather complex. We're not using any multi-line patterns in
the OPEA project. You can see complex examples in other open source projects
... | that should be reported. You can modify the filtering by adding or editing a conf file in the ``.known-issues`` folder, following the examples found there.
Multi-line patterns can get rather complex. We're not using any multi-line patterns in
the OPEA project. You can see complex examples in other open source projects
... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
21d89a8f-c7a2-4310-ad8c-4e5f46395cae | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 46 | opea-semantic-v1 | 77631bdb1c968a23 | error or warning to be generated. Doing a ``make clean`` to create a clean generation environment and a ``make html`` again generally fixes these issues.
Run the Documentation Processors
******************************** | ai_ref_knowledge | OPEA Documentation | error or warning to be generated. Doing a ``make clean`` to create a clean generation environment and a ``make html`` again generally fixes these issues.
Run the Documentation Processors
******************************** | error or warning to be generated. Doing a ``make clean`` to create a clean generation environment and a ``make html`` again generally fixes these issues.
Run the Documentation Processors
******************************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2256891f-3798-4a66-bce4-3dc6a933ff8d | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 20 | opea-semantic-v1 | 74972ba0077d54a6 | #. Use your browser to visit https://github.com/opea-project and do a fork of the **docs** repo to your personal GitHub account.)
#. At a command prompt, create the top working folder on your development
computer and clone your personal ``docs`` repository there: | ai_ref_knowledge | OPEA Documentation | #. Use your browser to visit https://github.com/opea-project and do a fork of the **docs** repo to your personal GitHub account.)
#. At a command prompt, create the top working folder on your development
computer and clone your personal ``docs`` repository there: | #. Use your browser to visit https://github.com/opea-project and do a fork of the **docs** repo to your personal GitHub account.)
#. At a command prompt, create the top working folder on your development
computer and clone your personal ``docs`` repository there: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
22a038e3-f5b6-42b2-985d-1a19d237c8fa | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 73 | opea-semantic-v1 | f21bbd9834c3b242 | Filter Expected Warnings ************************
Alas, there are some known issues with the Sphinx processing that generate
warnings. We've added a post-processing filter on the output of the
documentation build process to check for "expected" warning messages in the generated
log output. By doing this, only "unexpect... | ai_ref_knowledge | OPEA Documentation | Filter Expected Warnings ************************
Alas, there are some known issues with the Sphinx processing that generate
warnings. We've added a post-processing filter on the output of the
documentation build process to check for "expected" warning messages in the generated
log output. By doing this, only "unexpect... | Filter Expected Warnings ************************
Alas, there are some known issues with the Sphinx processing that generate
warnings. We've added a post-processing filter on the output of the
documentation build process to check for "expected" warning messages in the generated
log output. By doing this, only "unexpect... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
22ca498d-ce05-47c5-8838-782c4c388ac4 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 10 | opea-semantic-v1 | 0dc099b364441714 | at doc build time by scanning the directory structure. The list of microservices is also self-updated when new microservices are added to the GenAIComps/comps directory.
- The CODEOWNERS files in the repos, containing the list of responsible
reviewers for those repos, are processed into a nice looking table included i... | ai_ref_knowledge | OPEA Documentation | at doc build time by scanning the directory structure. The list of microservices is also self-updated when new microservices are added to the GenAIComps/comps directory.
- The CODEOWNERS files in the repos, containing the list of responsible
reviewers for those repos, are processed into a nice looking table included i... | at doc build time by scanning the directory structure. The list of microservices is also self-updated when new microservices are added to the GenAIComps/comps directory.
- The CODEOWNERS files in the repos, containing the list of responsible
reviewers for those repos, are processed into a nice looking table included i... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2362a7cb-5830-4a28-b3e3-b032324a0092 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 49 | opea-semantic-v1 | 6f9b67874e013abc | changes -- this is how you can verify your changes will not generate errors when your branch with changes is merged with the main branch.
cd ~/opea-project/docs
make clean
make html | ai_ref_knowledge | OPEA Documentation | changes -- this is how you can verify your changes will not generate errors when your branch with changes is merged with the main branch.
cd ~/opea-project/docs
make clean
make html | changes -- this is how you can verify your changes will not generate errors when your branch with changes is merged with the main branch.
cd ~/opea-project/docs
make clean
make html | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2381da4b-f57e-4cf1-bd08-8556624f884d | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 45 | opea-semantic-v1 | 0cb298296ad8a265 | theme template overrides found in ``doc/sphinx/_templates``. If you change to another theme, you'll need to tweak these customizations, not something for the faint of heart.
The Sphinx build system creates document cache information that attempts to
expedite documentation rebuilds, but occasionally can cause an unexpec... | ai_ref_knowledge | OPEA Documentation | theme template overrides found in ``doc/sphinx/_templates``. If you change to another theme, you'll need to tweak these customizations, not something for the faint of heart.
The Sphinx build system creates document cache information that attempts to
expedite documentation rebuilds, but occasionally can cause an unexpec... | theme template overrides found in ``doc/sphinx/_templates``. If you change to another theme, you'll need to tweak these customizations, not something for the faint of heart.
The Sphinx build system creates document cache information that attempts to
expedite documentation rebuilds, but occasionally can cause an unexpec... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
25df153a-b316-471b-ae99-0c0eb96ed9fc | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 42 | opea-semantic-v1 | 54882698b6467592 | doc build tool versions found on your system per /home/david/opea-project/docs/scripts/requirements.txt...
sphinx version: 7.3.0
docutils version: 0.20
sphinx-rtd-theme version: 2.0.0
sphinx-tabs version: 3.4.5
myst-parser version: 3.0.1
sphinx-md version: 0.0.3
sphinxcontrib-mermaid version: 0.9.2
pymarkdownlnt... | ai_ref_knowledge | OPEA Documentation | doc build tool versions found on your system per /home/david/opea-project/docs/scripts/requirements.txt...
sphinx version: 7.3.0
docutils version: 0.20
sphinx-rtd-theme version: 2.0.0
sphinx-tabs version: 3.4.5
myst-parser version: 3.0.1
sphinx-md version: 0.0.3
sphinxcontrib-mermaid version: 0.9.2
pymarkdownlnt... | doc build tool versions found on your system per /home/david/opea-project/docs/scripts/requirements.txt...
sphinx version: 7.3.0
docutils version: 0.20
sphinx-rtd-theme version: 2.0.0
sphinx-tabs version: 3.4.5
myst-parser version: 3.0.1
sphinx-md version: 0.0.3
sphinxcontrib-mermaid version: 0.9.2
pymarkdownlnt... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
26f0e122-31bb-447d-a69a-84688679b9c7 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 9 | opea-semantic-v1 | 6e9e95fe3cfdd8c2 | link works when reading the markdown file in the github.com repo, but should be changed to reference the generated HTML file in the github.io rendering.
- When new examples appear in the GenAIExamples repo, the indexing page that
lists all the examples is updated automatically by generating it at doc build
time by sc... | ai_ref_knowledge | OPEA Documentation | link works when reading the markdown file in the github.com repo, but should be changed to reference the generated HTML file in the github.io rendering.
- When new examples appear in the GenAIExamples repo, the indexing page that
lists all the examples is updated automatically by generating it at doc build
time by sc... | link works when reading the markdown file in the github.com repo, but should be changed to reference the generated HTML file in the github.io rendering.
- When new examples appear in the GenAIExamples repo, the indexing page that
lists all the examples is updated automatically by generating it at doc build
time by sc... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2f8d861b-1a1a-4f86-99aa-193ddb116f9b | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 34 | opea-semantic-v1 | feb6d2433d8c2952 | sudo apt install python3-pip python3-wheel make graphviz
Then use ``pip3`` to install the remaining Python-based tools specified in the
`scripts/requirements.txt` file | ai_ref_knowledge | OPEA Documentation | sudo apt install python3-pip python3-wheel make graphviz
Then use ``pip3`` to install the remaining Python-based tools specified in the
`scripts/requirements.txt` file | sudo apt install python3-pip python3-wheel make graphviz
Then use ``pip3`` to install the remaining Python-based tools specified in the
`scripts/requirements.txt` file | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
3796437c-00a0-4457-a6bf-ab7d17568149 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 82 | opea-semantic-v1 | fde014434e9a1610 | the Python script ``scripts/filter-known-issues.py`` together with a set of filter configuration files in the ``.known-issues`` folder. (This filtering is done as part of the ``Makefile``.)
The filtering tool matches and removes whole line and multi-line patterns to
remove them. Anything left behind is considered a mes... | ai_ref_knowledge | OPEA Documentation | the Python script ``scripts/filter-known-issues.py`` together with a set of filter configuration files in the ``.known-issues`` folder. (This filtering is done as part of the ``Makefile``.)
The filtering tool matches and removes whole line and multi-line patterns to
remove them. Anything left behind is considered a mes... | the Python script ``scripts/filter-known-issues.py`` together with a set of filter configuration files in the ``.known-issues`` folder. (This filtering is done as part of the ``Makefile``.)
The filtering tool matches and removes whole line and multi-line patterns to
remove them. Anything left behind is considered a mes... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
38df8a38-ccf3-4abf-9bfb-fcb3ea53fc98 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 16 | opea-semantic-v1 | ebe2b62cdbea4184 | the opea-project. You can use a different name for the parent folder but the doc build process assumes the repo names are as shown here:
opea-project
├── docs
├── GenAIComps
├── GenAIEval
├── GenAIExamples
├── GenAIInfra | ai_ref_knowledge | OPEA Documentation | the opea-project. You can use a different name for the parent folder but the doc build process assumes the repo names are as shown here:
opea-project
├── docs
├── GenAIComps
├── GenAIEval
├── GenAIExamples
├── GenAIInfra | the opea-project. You can use a different name for the parent folder but the doc build process assumes the repo names are as shown here:
opea-project
├── docs
├── GenAIComps
├── GenAIEval
├── GenAIExamples
├── GenAIInfra | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
40817e51-4599-4ac8-966d-4394cec3db0c | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 30 | opea-semantic-v1 | 088a34af34826b55 | has been tested to run on Ubuntu (both natively and in Windows Subsystem for Windows (wsl) with Python 3.8.10 and later, and these other tools:
* sphinx version: 7.3.0
* docutils version: 0.20
* sphinx-rtd-theme version: 2.0.0
* sphinx-tabs version: 3.4.5
* myst-parser version: 3.0.1
* sphinx-md version: 0.0.3
* sphinx... | ai_ref_knowledge | OPEA Documentation | has been tested to run on Ubuntu (both natively and in Windows Subsystem for Windows (wsl) with Python 3.8.10 and later, and these other tools:
* sphinx version: 7.3.0
* docutils version: 0.20
* sphinx-rtd-theme version: 2.0.0
* sphinx-tabs version: 3.4.5
* myst-parser version: 3.0.1
* sphinx-md version: 0.0.3
* sphinx... | has been tested to run on Ubuntu (both natively and in Windows Subsystem for Windows (wsl) with Python 3.8.10 and later, and these other tools:
* sphinx version: 7.3.0
* docutils version: 0.20
* sphinx-rtd-theme version: 2.0.0
* sphinx-tabs version: 3.4.5
* myst-parser version: 3.0.1
* sphinx-md version: 0.0.3
* sphinx... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
45c5b3f6-a0e7-4c1f-9f03-da1366963af6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 36 | opea-semantic-v1 | 1a8714d84c724a39 | cd ~/opea-project/docs pip3 install --user -r scripts/requirements.txt
Use this command to add ``$HOME/.local/bin`` to the front of your ``PATH`` so
the system will find expected versions of these Python utilities such as
``sphinx-build`` (you should first check whether this folder is already on your
path): | ai_ref_knowledge | OPEA Documentation | cd ~/opea-project/docs pip3 install --user -r scripts/requirements.txt
Use this command to add ``$HOME/.local/bin`` to the front of your ``PATH`` so
the system will find expected versions of these Python utilities such as
``sphinx-build`` (you should first check whether this folder is already on your
path): | cd ~/opea-project/docs pip3 install --user -r scripts/requirements.txt
Use this command to add ``$HOME/.local/bin`` to the front of your ``PATH`` so
the system will find expected versions of these Python utilities such as
``sphinx-build`` (you should first check whether this folder is already on your
path): | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
46be432c-727f-4700-9e13-eb6092142ba6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 66 | opea-semantic-v1 | 3545e9f2f77a4ac1 | GitHub pages publishing repo (``opea-project.github.io.git``. The public site at https://opea-project.github.io will be automatically updated by the `GitHub pages system <https://guides.github.com/features/pages/>`_, typically within a few minutes.
Document Versioning
******************* | ai_ref_knowledge | OPEA Documentation | GitHub pages publishing repo (``opea-project.github.io.git``. The public site at https://opea-project.github.io will be automatically updated by the `GitHub pages system <https://guides.github.com/features/pages/>`_, typically within a few minutes.
Document Versioning
******************* | GitHub pages publishing repo (``opea-project.github.io.git``. The public site at https://opea-project.github.io will be automatically updated by the `GitHub pages system <https://guides.github.com/features/pages/>`_, typically within a few minutes.
Document Versioning
******************* | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
477ddd83-98c8-40fc-91b4-2474f2fdb18e | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 70 | opea-semantic-v1 | 0ddb73d50df7fa74 | number and publishing folder. Note that there's no direct selection to go to a newer version from an older one, without going to ``latest`` first.
By default, documentation build and publishing both assume we're generating
documentation for the main branch and publishing to the ``/latest/`` area on
https://opea-project... | ai_ref_knowledge | OPEA Documentation | number and publishing folder. Note that there's no direct selection to go to a newer version from an older one, without going to ``latest`` first.
By default, documentation build and publishing both assume we're generating
documentation for the main branch and publishing to the ``/latest/`` area on
https://opea-project... | number and publishing folder. Note that there's no direct selection to go to a newer version from an older one, without going to ``latest`` first.
By default, documentation build and publishing both assume we're generating
documentation for the main branch and publishing to the ``/latest/`` area on
https://opea-project... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
51749c4e-147e-41e6-8373-e189885ee45b | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 11 | opea-semantic-v1 | 787cce4cfffb185f | in the ``community/codeowners.md`` document. That way the list of project code owners is kept in sync with what's in the CODEOWNERS files used by GitHub.
- References in markdown files to markdown files (.md file extension) are
converted to the corresponding generated HTML files by Sphinx using the Myst and
sphinx-md... | ai_ref_knowledge | OPEA Documentation | in the ``community/codeowners.md`` document. That way the list of project code owners is kept in sync with what's in the CODEOWNERS files used by GitHub.
- References in markdown files to markdown files (.md file extension) are
converted to the corresponding generated HTML files by Sphinx using the Myst and
sphinx-md... | in the ``community/codeowners.md`` document. That way the list of project code owners is kept in sync with what's in the CODEOWNERS files used by GitHub.
- References in markdown files to markdown files (.md file extension) are
converted to the corresponding generated HTML files by Sphinx using the Myst and
sphinx-md... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
52b853d6-9d6f-4b36-9030-c3e6fcc1c922 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 74 | opea-semantic-v1 | e2c25a83f4be2787 | messages in the generated log output. By doing this, only "unexpected" messages will be reported and cause the build process to fail with a message:
New errors/warnings found, please fix them: | ai_ref_knowledge | OPEA Documentation | messages in the generated log output. By doing this, only "unexpected" messages will be reported and cause the build process to fail with a message:
New errors/warnings found, please fix them: | messages in the generated log output. By doing this, only "unexpected" messages will be reported and cause the build process to fail with a message:
New errors/warnings found, please fix them: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
56e3944b-184f-4382-b158-fb16262cda9f | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 44 | opea-semantic-v1 | f7c33b8aaf56c515 | Documentation Presentation Theme ********************************
Sphinx supports easy customization of the generated HTML documentation
appearance through the use of themes. The ``sphinx-rtd-theme`` (Read The Docs)
theme is installed as part of the ``requirements.txt`` list above. Tweaks to
the standard ``read-the-doc... | ai_ref_knowledge | OPEA Documentation | Documentation Presentation Theme ********************************
Sphinx supports easy customization of the generated HTML documentation
appearance through the use of themes. The ``sphinx-rtd-theme`` (Read The Docs)
theme is installed as part of the ``requirements.txt`` list above. Tweaks to
the standard ``read-the-doc... | Documentation Presentation Theme ********************************
Sphinx supports easy customization of the generated HTML documentation
appearance through the use of themes. The ``sphinx-rtd-theme`` (Read The Docs)
theme is installed as part of the ``requirements.txt`` list above. Tweaks to
the standard ``read-the-doc... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
62b7c9fa-0dec-4a9f-8474-a080be5f3bf9 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 13 | opea-semantic-v1 | 216c7d1523946934 | Set Up the Documentation Working Folders ****************************************
To begin, you'll need ``git`` installed to get the working folders set up: | ai_ref_knowledge | OPEA Documentation | Set Up the Documentation Working Folders ****************************************
To begin, you'll need ``git`` installed to get the working folders set up: | Set Up the Documentation Working Folders ****************************************
To begin, you'll need ``git`` installed to get the working folders set up: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
65f048c2-9ff1-4783-894b-78f0bb0d09e9 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 31 | opea-semantic-v1 | 7c7083277b1c6177 | 0.20 * sphinx-rtd-theme version: 2.0.0 * sphinx-tabs version: 3.4.5 * myst-parser version: 3.0.1 * sphinx-md version: 0.0.3 * sphinxcontrib-mermaid version: 0.9.2 * pymarkdownlnt version: 0.9.21
Depending on your Linux version, install the needed tools. | ai_ref_knowledge | OPEA Documentation | 0.20 * sphinx-rtd-theme version: 2.0.0 * sphinx-tabs version: 3.4.5 * myst-parser version: 3.0.1 * sphinx-md version: 0.0.3 * sphinxcontrib-mermaid version: 0.9.2 * pymarkdownlnt version: 0.9.21
Depending on your Linux version, install the needed tools. | 0.20 * sphinx-rtd-theme version: 2.0.0 * sphinx-tabs version: 3.4.5 * myst-parser version: 3.0.1 * sphinx-md version: 0.0.3 * sphinxcontrib-mermaid version: 0.9.2 * pymarkdownlnt version: 0.9.21
Depending on your Linux version, install the needed tools. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6e110264-eef1-4723-b11e-0943f91b9252 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 69 | opea-semantic-v1 | 27b261fff0a3d68e | html_context = { 'current_version': current_version, 'docs_title': docs_title, 'is_release': is_release, 'versions': ( ("latest", "/latest/"), ("1.0", "/1.0/"), ) }
As new versions of OPEA documentation are added, typically when a new release is
made, update this ``versions`` selection list to include the version numbe... | ai_ref_knowledge | OPEA Documentation | html_context = { 'current_version': current_version, 'docs_title': docs_title, 'is_release': is_release, 'versions': ( ("latest", "/latest/"), ("1.0", "/1.0/"), ) }
As new versions of OPEA documentation are added, typically when a new release is
made, update this ``versions`` selection list to include the version numbe... | html_context = { 'current_version': current_version, 'docs_title': docs_title, 'is_release': is_release, 'versions': ( ("latest", "/latest/"), ("1.0", "/1.0/"), ) }
As new versions of OPEA documentation are added, typically when a new release is
made, update this ``versions`` selection list to include the version numbe... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6f9c888c-cdc6-40b9-93f8-11cb5045931a | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 61 | opea-semantic-v1 | 6714c2da38ebe1ed | If you have merge rights to the opea-project ``opea-project.github.io`` repo, you can update the public project documentation found at https://opea-project.github.io.
You'll need to do a one-time clone of the upstream repo (we publish
directly to the upstream repo rather than to a personal forked copy): | ai_ref_knowledge | OPEA Documentation | If you have merge rights to the opea-project ``opea-project.github.io`` repo, you can update the public project documentation found at https://opea-project.github.io.
You'll need to do a one-time clone of the upstream repo (we publish
directly to the upstream repo rather than to a personal forked copy): | If you have merge rights to the opea-project ``opea-project.github.io`` repo, you can update the public project documentation found at https://opea-project.github.io.
You'll need to do a one-time clone of the upstream repo (we publish
directly to the upstream repo rather than to a personal forked copy): | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
7015ca11-c1b7-4323-93b5-9876ab564dda | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 63 | opea-semantic-v1 | 8a8066855c0ada5c | cd ~/opea-project git clone https://github.com/opea-project/opea-project.github.io.git
Then, after you've verified the generated HTML produced by ``make html`` looks
good, you can push to the publishing site with: | ai_ref_knowledge | OPEA Documentation | cd ~/opea-project git clone https://github.com/opea-project/opea-project.github.io.git
Then, after you've verified the generated HTML produced by ``make html`` looks
good, you can push to the publishing site with: | cd ~/opea-project git clone https://github.com/opea-project/opea-project.github.io.git
Then, after you've verified the generated HTML produced by ``make html`` looks
good, you can push to the publishing site with: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
70f4c6b9-434e-4615-95ef-ba1c13a12fae | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 17 | opea-semantic-v1 | 64a66564df58fcf2 | opea-project ├── docs ├── GenAIComps ├── GenAIEval ├── GenAIExamples ├── GenAIInfra
The parent ``opea-project`` folder is there to organize the cloned repos
from the project. | ai_ref_knowledge | OPEA Documentation | opea-project ├── docs ├── GenAIComps ├── GenAIEval ├── GenAIExamples ├── GenAIInfra
The parent ``opea-project`` folder is there to organize the cloned repos
from the project. | opea-project ├── docs ├── GenAIComps ├── GenAIEval ├── GenAIExamples ├── GenAIInfra
The parent ``opea-project`` folder is there to organize the cloned repos
from the project. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
72703438-9788-45f7-b92f-a5a849122cea | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 56 | opea-semantic-v1 | 834c8bc7913fea0d | Doc Build Troubleshooting *************************
It's worth mentioning again, all ``.md`` and ``.rst`` documents must appear in
the toctree hierarchy. When a new document is added it might cause the doc build to fail
because that new document is not found in any of the toctree directives. Some
doc additions are auto... | ai_ref_knowledge | OPEA Documentation | Doc Build Troubleshooting *************************
It's worth mentioning again, all ``.md`` and ``.rst`` documents must appear in
the toctree hierarchy. When a new document is added it might cause the doc build to fail
because that new document is not found in any of the toctree directives. Some
doc additions are auto... | Doc Build Troubleshooting *************************
It's worth mentioning again, all ``.md`` and ``.rst`` documents must appear in
the toctree hierarchy. When a new document is added it might cause the doc build to fail
because that new document is not found in any of the toctree directives. Some
doc additions are auto... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
75c89383-2613-44fc-9196-dedd853225e9 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 38 | opea-semantic-v1 | feacdd8d1faa765e | printf "\nexport PATH=\$HOME/.local/bin:\$PATH" >> ~/.bashrc
You will need to open a new terminal for this change to take effect. Adding this to your ``~/.bashrc`` file ensures it is set by default. | ai_ref_knowledge | OPEA Documentation | printf "\nexport PATH=\$HOME/.local/bin:\$PATH" >> ~/.bashrc
You will need to open a new terminal for this change to take effect. Adding this to your ``~/.bashrc`` file ensures it is set by default. | printf "\nexport PATH=\$HOME/.local/bin:\$PATH" >> ~/.bashrc
You will need to open a new terminal for this change to take effect. Adding this to your ``~/.bashrc`` file ensures it is set by default. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
7aa8e8ae-83ed-4da5-90b4-8c5f6e255351 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 75 | opea-semantic-v1 | db7aaa4e13adb107 | New errors/warnings found, please fix them:
followed by messages that weren't expected. Note that the file names shown in
the error/warning messages will be for files in the ``_build/rst`` folder
(copied from the repos). For example, | ai_ref_knowledge | OPEA Documentation | New errors/warnings found, please fix them:
followed by messages that weren't expected. Note that the file names shown in
the error/warning messages will be for files in the ``_build/rst`` folder
(copied from the repos). For example, | New errors/warnings found, please fix them:
followed by messages that weren't expected. Note that the file names shown in
the error/warning messages will be for files in the ``_build/rst`` folder
(copied from the repos). For example, | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
7caabe55-d9b7-42d1-86e7-5e45c2577fe6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 52 | opea-semantic-v1 | bc5232fcbc8dac2d | As a convenience, there's a make target that will ``cd`` to the ``_build/html`` folder and run a local Python web server on port 8000:
make server | ai_ref_knowledge | OPEA Documentation | As a convenience, there's a make target that will ``cd`` to the ``_build/html`` folder and run a local Python web server on port 8000:
make server | As a convenience, there's a make target that will ``cd`` to the ``_build/html`` folder and run a local Python web server on port 8000:
make server | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
7ead5f54-3fa5-4daf-8592-5aeea7644887 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 4 | opea-semantic-v1 | 14c9f62779d11dd1 | You can read details about `markdown`_, `reStructuredText`_, and `Sphinx`_ from their respective websites.
The project's documentation is a collection of ReStructuredText and markdown
source files used to generate documentation found at the
https://opea-project.github.io website. All of the documentation sources are
fo... | ai_ref_knowledge | OPEA Documentation | You can read details about `markdown`_, `reStructuredText`_, and `Sphinx`_ from their respective websites.
The project's documentation is a collection of ReStructuredText and markdown
source files used to generate documentation found at the
https://opea-project.github.io website. All of the documentation sources are
fo... | You can read details about `markdown`_, `reStructuredText`_, and `Sphinx`_ from their respective websites.
The project's documentation is a collection of ReStructuredText and markdown
source files used to generate documentation found at the
https://opea-project.github.io website. All of the documentation sources are
fo... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
81b87b94-25dd-453a-ab22-b0edc3869ce4 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 8 | opea-semantic-v1 | aab3d489165870ad | See [GMC Install](https://github.com/opea-project/GenAIInfra/tree/main/microservices-connector/README.md).
That link works when reading the markdown file in the github.com repo, but
should be changed to reference the generated HTML file in the github.io
rendering. | ai_ref_knowledge | OPEA Documentation | See [GMC Install](https://github.com/opea-project/GenAIInfra/tree/main/microservices-connector/README.md).
That link works when reading the markdown file in the github.com repo, but
should be changed to reference the generated HTML file in the github.io
rendering. | See [GMC Install](https://github.com/opea-project/GenAIInfra/tree/main/microservices-connector/README.md).
That link works when reading the markdown file in the github.com repo, but
should be changed to reference the generated HTML file in the github.io
rendering. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
856ce983-9f7c-49b4-9ec4-f37dc48a4a7e | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 14 | opea-semantic-v1 | 95892f89bbeeaabc | To begin, you'll need ``git`` installed to get the working folders set up:
* For an Ubuntu development system use: | ai_ref_knowledge | OPEA Documentation | To begin, you'll need ``git`` installed to get the working folders set up:
* For an Ubuntu development system use: | To begin, you'll need ``git`` installed to get the working folders set up:
* For an Ubuntu development system use: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9103b8b6-e0fc-4573-bf9b-228a361857c5 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 67 | opea-semantic-v1 | c01bad5306886083 | Document Versioning *******************
The https://opea-project.github.io site has a document version selector
at the top of the left nav panel. The contents of this version
selector are defined in the ``conf.py`` sphinx configuration file,
specifically something like this: | ai_ref_knowledge | OPEA Documentation | Document Versioning *******************
The https://opea-project.github.io site has a document version selector
at the top of the left nav panel. The contents of this version
selector are defined in the ``conf.py`` sphinx configuration file,
specifically something like this: | Document Versioning *******************
The https://opea-project.github.io site has a document version selector
at the top of the left nav panel. The contents of this version
selector are defined in the ``conf.py`` sphinx configuration file,
specifically something like this: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9225faa0-e209-4458-9011-7a82681e6975 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 57 | opea-semantic-v1 | cd6e73c1e95820d4 | (or in parent directory) would be the first place to check if the doc build complains that a document is not listed in a toctree.
The :ref:`GenAIExamples` and :ref:`GenAIMicroservices` documents hierarchy are a
special case. Both of these documents are augmented at build time by a script
(:docs_blob:`scripts/maketoc.sh... | ai_ref_knowledge | OPEA Documentation | (or in parent directory) would be the first place to check if the doc build complains that a document is not listed in a toctree.
The :ref:`GenAIExamples` and :ref:`GenAIMicroservices` documents hierarchy are a
special case. Both of these documents are augmented at build time by a script
(:docs_blob:`scripts/maketoc.sh... | (or in parent directory) would be the first place to check if the doc build complains that a document is not listed in a toctree.
The :ref:`GenAIExamples` and :ref:`GenAIMicroservices` documents hierarchy are a
special case. Both of these documents are augmented at build time by a script
(:docs_blob:`scripts/maketoc.sh... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
96082c0b-4d01-42eb-9e71-a6dd568be4b0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 0 | opea-semantic-v1 | 6fcdd65f63229388 | OPEA Documentation Generation #############################
These instructions walk you through generating the OPEA project documentation
and publishing it to https://opea-project.github.io. You can also use these
instructions to generate the OPEA documentation on your local system. | ai_ref_knowledge | OPEA Documentation | OPEA Documentation Generation #############################
These instructions walk you through generating the OPEA project documentation
and publishing it to https://opea-project.github.io. You can also use these
instructions to generate the OPEA documentation on your local system. | OPEA Documentation Generation #############################
These instructions walk you through generating the OPEA project documentation
and publishing it to https://opea-project.github.io. You can also use these
instructions to generate the OPEA documentation on your local system. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
97ca64f6-3098-4bd2-bcce-16bb4eed3d56 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 80 | opea-semantic-v1 | 61e5978f9e3a65d6 | left behind from a previous build that can cause some unexpected messages to be reported. If things look suspicious, do a ``make clean;make html`` again.
If all messages were filtered away,
the build process will report as successful, reporting: | ai_ref_knowledge | OPEA Documentation | left behind from a previous build that can cause some unexpected messages to be reported. If things look suspicious, do a ``make clean;make html`` again.
If all messages were filtered away,
the build process will report as successful, reporting: | left behind from a previous build that can cause some unexpected messages to be reported. If things look suspicious, do a ``make clean;make html`` again.
If all messages were filtered away,
the build process will report as successful, reporting: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9d6e1571-4658-47ce-9122-104a11a56093 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 65 | opea-semantic-v1 | e8dbc1785abcdd82 | make publish
This uses git commands to synchronize the new content with what's
already published and will delete files in the publishing repo's
**latest** folder that are no longer needed. New or changed files from
the newly-generated HTML content are pushed to the GitHub pages
publishing repo (``opea-project.github.io... | ai_ref_knowledge | OPEA Documentation | make publish
This uses git commands to synchronize the new content with what's
already published and will delete files in the publishing repo's
**latest** folder that are no longer needed. New or changed files from
the newly-generated HTML content are pushed to the GitHub pages
publishing repo (``opea-project.github.io... | make publish
This uses git commands to synchronize the new content with what's
already published and will delete files in the publishing repo's
**latest** folder that are no longer needed. New or changed files from
the newly-generated HTML content are pushed to the GitHub pages
publishing repo (``opea-project.github.io... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ac9475bd-b579-4e54-a353-79eb1f135530 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 77 | opea-semantic-v1 | 9f5fb4eb6b546f5c | New errors/warnings found, please fix them:
/home/david/opea-project/docs/_build/rst/GenAIInfra/kubernetes-addons/Observability/README.md:5: WARNING: Non-consecutive header level increase; H1 to H4 [myst.header]
/home/david/opea-project/docs/_build/rst/GenAIInfra/kubernetes-addons/Observability/README.md:111: WARNING:... | ai_ref_knowledge | OPEA Documentation | New errors/warnings found, please fix them:
/home/david/opea-project/docs/_build/rst/GenAIInfra/kubernetes-addons/Observability/README.md:5: WARNING: Non-consecutive header level increase; H1 to H4 [myst.header]
/home/david/opea-project/docs/_build/rst/GenAIInfra/kubernetes-addons/Observability/README.md:111: WARNING:... | New errors/warnings found, please fix them:
/home/david/opea-project/docs/_build/rst/GenAIInfra/kubernetes-addons/Observability/README.md:5: WARNING: Non-consecutive header level increase; H1 to H4 [myst.header]
/home/david/opea-project/docs/_build/rst/GenAIInfra/kubernetes-addons/Observability/README.md:111: WARNING:... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
aec2316c-4d2d-4be6-95e8-03d8dcbecdb0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 18 | opea-semantic-v1 | 8434a4405bd2ddaf | The parent ``opea-project`` folder is there to organize the cloned repos from the project.
In the following steps, you'll create a fork of all the upstream OPEA project
repos needed to build the documentation to your personal GitHub account, clone
your personal fork to your local development computer, and then link tha... | ai_ref_knowledge | OPEA Documentation | The parent ``opea-project`` folder is there to organize the cloned repos from the project.
In the following steps, you'll create a fork of all the upstream OPEA project
repos needed to build the documentation to your personal GitHub account, clone
your personal fork to your local development computer, and then link tha... | The parent ``opea-project`` folder is there to organize the cloned repos from the project.
In the following steps, you'll create a fork of all the upstream OPEA project
repos needed to build the documentation to your personal GitHub account, clone
your personal fork to your local development computer, and then link tha... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b1e2ed75-f4d8-4362-b6c5-7e83ef077d53 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 59 | opea-semantic-v1 | b81df1a491388c71 | build the docs again. (This might mean making changes to documents in other OPEA project repos, submitting a PR, and getting that approved and merged.)
Publish Content
*************** | ai_ref_knowledge | OPEA Documentation | build the docs again. (This might mean making changes to documents in other OPEA project repos, submitting a PR, and getting that approved and merged.)
Publish Content
*************** | build the docs again. (This might mean making changes to documents in other OPEA project repos, submitting a PR, and getting that approved and merged.)
Publish Content
*************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b21df45c-cd67-4033-8d63-0bca079d75b7 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 15 | opea-semantic-v1 | 4089baa8fd8bdd07 | sudo apt install git
Here's the recommended folder setup for documentation contributions and
generation, a parent folder called ``opea-project`` holds five locally
cloned repos from the opea-project. You can use a different name for the parent
folder but the doc build process assumes the repo names are as shown here: | ai_ref_knowledge | OPEA Documentation | sudo apt install git
Here's the recommended folder setup for documentation contributions and
generation, a parent folder called ``opea-project`` holds five locally
cloned repos from the opea-project. You can use a different name for the parent
folder but the doc build process assumes the repo names are as shown here: | sudo apt install git
Here's the recommended folder setup for documentation contributions and
generation, a parent folder called ``opea-project`` holds five locally
cloned repos from the opea-project. You can use a different name for the parent
folder but the doc build process assumes the repo names are as shown here: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b3d9bb82-5814-433d-a239-6a5e76f44fc3 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 50 | opea-semantic-v1 | 74c366476ec4e951 | cd ~/opea-project/docs make clean make html
Depending on your development system, it will take about a minute to collect and
generate the HTML content. When done, you can view the HTML output in
``~/opea-project/docs/_build/html/index.html``. | ai_ref_knowledge | OPEA Documentation | cd ~/opea-project/docs make clean make html
Depending on your development system, it will take about a minute to collect and
generate the HTML content. When done, you can view the HTML output in
``~/opea-project/docs/_build/html/index.html``. | cd ~/opea-project/docs make clean make html
Depending on your development system, it will take about a minute to collect and
generate the HTML content. When done, you can view the HTML output in
``~/opea-project/docs/_build/html/index.html``. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b5165c2d-9cc4-4062-831e-80237147336a | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 51 | opea-semantic-v1 | 0933967d49aaa19a | development system, it will take about a minute to collect and generate the HTML content. When done, you can view the HTML output in ``~/opea-project/docs/_build/html/index.html``.
As a convenience, there's a make target that will ``cd`` to the ``_build/html``
folder and run a local Python web server on port 8000: | ai_ref_knowledge | OPEA Documentation | development system, it will take about a minute to collect and generate the HTML content. When done, you can view the HTML output in ``~/opea-project/docs/_build/html/index.html``.
As a convenience, there's a make target that will ``cd`` to the ``_build/html``
folder and run a local Python web server on port 8000: | development system, it will take about a minute to collect and generate the HTML content. When done, you can view the HTML output in ``~/opea-project/docs/_build/html/index.html``.
As a convenience, there's a make target that will ``cd`` to the ``_build/html``
folder and run a local Python web server on port 8000: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b5e10385-ac9d-4c4c-bc2a-19e0d82f5395 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 35 | opea-semantic-v1 | 8d21ac08fa63f418 | Then use ``pip3`` to install the remaining Python-based tools specified in the `scripts/requirements.txt` file
cd ~/opea-project/docs
pip3 install --user -r scripts/requirements.txt | ai_ref_knowledge | OPEA Documentation | Then use ``pip3`` to install the remaining Python-based tools specified in the `scripts/requirements.txt` file
cd ~/opea-project/docs
pip3 install --user -r scripts/requirements.txt | Then use ``pip3`` to install the remaining Python-based tools specified in the `scripts/requirements.txt` file
cd ~/opea-project/docs
pip3 install --user -r scripts/requirements.txt | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b8d01de2-3821-47e3-821d-ea84dbae60df | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 5 | opea-semantic-v1 | f67c4b1751da140b | and ``GenAIInfra``. The documentation generation process collects all the needed files from all these repos into one building area to create the final generated HTML.
.. graphviz:: images/doc-gen-flow.dot | ai_ref_knowledge | OPEA Documentation | and ``GenAIInfra``. The documentation generation process collects all the needed files from all these repos into one building area to create the final generated HTML.
.. graphviz:: images/doc-gen-flow.dot | and ``GenAIInfra``. The documentation generation process collects all the needed files from all these repos into one building area to create the final generated HTML.
.. graphviz:: images/doc-gen-flow.dot | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
bdca007b-cbbf-4495-9cbb-e39def86c860 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 37 | opea-semantic-v1 | 5ef6999d3ae2f44b | the system will find expected versions of these Python utilities such as ``sphinx-build`` (you should first check whether this folder is already on your path):
printf "\nexport PATH=\$HOME/.local/bin:\$PATH" >> ~/.bashrc | ai_ref_knowledge | OPEA Documentation | the system will find expected versions of these Python utilities such as ``sphinx-build`` (you should first check whether this folder is already on your path):
printf "\nexport PATH=\$HOME/.local/bin:\$PATH" >> ~/.bashrc | the system will find expected versions of these Python utilities such as ``sphinx-build`` (you should first check whether this folder is already on your path):
printf "\nexport PATH=\$HOME/.local/bin:\$PATH" >> ~/.bashrc | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
be0f123f-28be-4e76-a02c-158e07421efd | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 55 | opea-semantic-v1 | e08281b6804de173 | commit -s``) your changes, push those changes to your personal forked repo (``git push origin <branchname>``) and submit a PR using the GitHub web interface.
.. _docbuild-troubleshooting: | ai_ref_knowledge | OPEA Documentation | commit -s``) your changes, push those changes to your personal forked repo (``git push origin <branchname>``) and submit a PR using the GitHub web interface.
.. _docbuild-troubleshooting: | commit -s``) your changes, push those changes to your personal forked repo (``git push origin <branchname>``) and submit a PR using the GitHub web interface.
.. _docbuild-troubleshooting: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c4e46c73-159d-4d3a-a23f-55ff0fb8fff6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 72 | opea-semantic-v1 | 21968ac5be4ec0e7 | version=1.0 for d in docs GenAIComps GenAIExamples GenAIEval GenAIInfra ; do cd ~/opea-project/$d git checkout $version done
cd ~/opea-project/docs
make clean
make DOC_TAG=release RELEASE=$version html
make DOC_TAG=release RELEASE=$version publish | ai_ref_knowledge | OPEA Documentation | version=1.0 for d in docs GenAIComps GenAIExamples GenAIEval GenAIInfra ; do cd ~/opea-project/$d git checkout $version done
cd ~/opea-project/docs
make clean
make DOC_TAG=release RELEASE=$version html
make DOC_TAG=release RELEASE=$version publish | version=1.0 for d in docs GenAIComps GenAIExamples GenAIEval GenAIInfra ; do cd ~/opea-project/$d git checkout $version done
cd ~/opea-project/docs
make clean
make DOC_TAG=release RELEASE=$version html
make DOC_TAG=release RELEASE=$version publish | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c7207e09-b476-403f-be3d-9d7b05d216f6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 23 | opea-semantic-v1 | 7bcfc5ead27dbd26 | cd docs git remote add upstream https://github.com/opea-project/docs.git
After that, you'll have ``origin`` pointing to your cloned personal ``docs``
repo and ``upstream`` pointing to the project ``docs`` repo. | ai_ref_knowledge | OPEA Documentation | cd docs git remote add upstream https://github.com/opea-project/docs.git
After that, you'll have ``origin`` pointing to your cloned personal ``docs``
repo and ``upstream`` pointing to the project ``docs`` repo. | cd docs git remote add upstream https://github.com/opea-project/docs.git
After that, you'll have ``origin`` pointing to your cloned personal ``docs``
repo and ``upstream`` pointing to the project ``docs`` repo. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c79277f8-9a4d-4f50-9d0c-7c3b08542480 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 29 | opea-semantic-v1 | 68532a5bad50464d | Install the Documentation Tools *******************************
Our documentation processing has been tested to run on Ubuntu (both natively and
in Windows Subsystem for Windows (wsl) with Python 3.8.10 and
later, and these other tools: | ai_ref_knowledge | OPEA Documentation | Install the Documentation Tools *******************************
Our documentation processing has been tested to run on Ubuntu (both natively and
in Windows Subsystem for Windows (wsl) with Python 3.8.10 and
later, and these other tools: | Install the Documentation Tools *******************************
Our documentation processing has been tested to run on Ubuntu (both natively and
in Windows Subsystem for Windows (wsl) with Python 3.8.10 and
later, and these other tools: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cbc3dc4c-9e4e-4153-a503-2ed673b654f0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 2 | opea-semantic-v1 | e91c4e784f4ea491 | Documentation Overview **********************
OPEA project content is written using combination of markdown (``.md``) and
reStructuredText (``.rst``) markup languages (with Sphinx extensions such as
`Myst <https://myst-parser.readthedocs.io/en/latest/index.html>`_), and
processed using Sphinx to create a formatted stan... | ai_ref_knowledge | OPEA Documentation | Documentation Overview **********************
OPEA project content is written using combination of markdown (``.md``) and
reStructuredText (``.rst``) markup languages (with Sphinx extensions such as
`Myst <https://myst-parser.readthedocs.io/en/latest/index.html>`_), and
processed using Sphinx to create a formatted stan... | Documentation Overview **********************
OPEA project content is written using combination of markdown (``.md``) and
reStructuredText (``.rst``) markup languages (with Sphinx extensions such as
`Myst <https://myst-parser.readthedocs.io/en/latest/index.html>`_), and
processed using Sphinx to create a formatted stan... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cbd47b7b-9176-43ae-8c3a-509c3bab2883 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 60 | opea-semantic-v1 | c4e6f7d5e1e280d6 | Publish Content ***************
If you have merge rights to the opea-project ``opea-project.github.io`` repo,
you can update the public project documentation found at
https://opea-project.github.io. | ai_ref_knowledge | OPEA Documentation | Publish Content ***************
If you have merge rights to the opea-project ``opea-project.github.io`` repo,
you can update the public project documentation found at
https://opea-project.github.io. | Publish Content ***************
If you have merge rights to the opea-project ``opea-project.github.io`` repo,
you can update the public project documentation found at
https://opea-project.github.io. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cd61b012-56c8-4891-aa7b-f3e983c71b8a | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 28 | opea-semantic-v1 | 4934966eaf944a65 | #. If you haven't done so already, configure git with your name and email address for the ``Signed-off-by`` line in your commit messages:
git config --global user.name "David Developer"
git config --global user.email "david.developer@company.com" | ai_ref_knowledge | OPEA Documentation | #. If you haven't done so already, configure git with your name and email address for the ``Signed-off-by`` line in your commit messages:
git config --global user.name "David Developer"
git config --global user.email "david.developer@company.com" | #. If you haven't done so already, configure git with your name and email address for the ``Signed-off-by`` line in your commit messages:
git config --global user.name "David Developer"
git config --global user.email "david.developer@company.com" | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cfe50440-ed5e-4a08-8a5f-7d742b79fc62 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 33 | opea-semantic-v1 | e356b3ef221ae256 | You should consider using the `Python virtual environment`_ tools to maintain your Python environment from being changed by other work on your computer.
For Ubuntu, use: | ai_ref_knowledge | OPEA Documentation | You should consider using the `Python virtual environment`_ tools to maintain your Python environment from being changed by other work on your computer.
For Ubuntu, use: | You should consider using the `Python virtual environment`_ tools to maintain your Python environment from being changed by other work on your computer.
For Ubuntu, use: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d0f27df5-4f35-42ab-8c5d-e8055dc50b40 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 40 | opea-semantic-v1 | 8c4e4b2730722d5b | And with that you're ready to generate the documentation.
We've provided a script in the docs repo you can run to show what versions of
the documentation building tools are installed and compare with the tool
versions shown above. This tool will also verify you're using tool versions
known to work together:: | ai_ref_knowledge | OPEA Documentation | And with that you're ready to generate the documentation.
We've provided a script in the docs repo you can run to show what versions of
the documentation building tools are installed and compare with the tool
versions shown above. This tool will also verify you're using tool versions
known to work together:: | And with that you're ready to generate the documentation.
We've provided a script in the docs repo you can run to show what versions of
the documentation building tools are installed and compare with the tool
versions shown above. This tool will also verify you're using tool versions
known to work together:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d366b144-d8a0-4d4f-876a-a5fb2f015232 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 58 | opea-semantic-v1 | ae6a549a74d845eb | found in the ``GenAIExamples`` and ``GenAIComps/comps`` directories. As new examples or microservice components are added, the doc build scripts should automatically incorporate those new documents.
Sphinx (and the Myst parser extension) may warn about issues with markdown
syntax or structure. Some of these warnings, t... | ai_ref_knowledge | OPEA Documentation | found in the ``GenAIExamples`` and ``GenAIComps/comps`` directories. As new examples or microservice components are added, the doc build scripts should automatically incorporate those new documents.
Sphinx (and the Myst parser extension) may warn about issues with markdown
syntax or structure. Some of these warnings, t... | found in the ``GenAIExamples`` and ``GenAIComps/comps`` directories. As new examples or microservice components are added, the doc build scripts should automatically incorporate those new documents.
Sphinx (and the Myst parser extension) may warn about issues with markdown
syntax or structure. Some of these warnings, t... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d4199282-2f7a-4136-a766-463669d338fc | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 41 | opea-semantic-v1 | 5a9d368ae571471e | building tools are installed and compare with the tool versions shown above. This tool will also verify you're using tool versions known to work together::
docs/scripts/show-versions.py | ai_ref_knowledge | OPEA Documentation | building tools are installed and compare with the tool versions shown above. This tool will also verify you're using tool versions known to work together::
docs/scripts/show-versions.py | building tools are installed and compare with the tool versions shown above. This tool will also verify you're using tool versions known to work together::
docs/scripts/show-versions.py | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d73ca45f-8535-442f-954c-3b0a9762b3a1 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 32 | opea-semantic-v1 | be1907ca8d2d9664 | Depending on your Linux version, install the needed tools.
You should consider using the `Python virtual environment`_ tools
to maintain your Python environment from being changed by other work on your
computer. | ai_ref_knowledge | OPEA Documentation | Depending on your Linux version, install the needed tools.
You should consider using the `Python virtual environment`_ tools
to maintain your Python environment from being changed by other work on your
computer. | Depending on your Linux version, install the needed tools.
You should consider using the `Python virtual environment`_ tools
to maintain your Python environment from being changed by other work on your
computer. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d953ef14-95a9-4ab7-a503-53952294bd2f | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 79 | opea-semantic-v1 | a0bdbad12e68ab8a | path to specific file with an issue. For example, the warnings shown here indicate a heading level problem on lines 5 and 111 in ``GenAIInfra/kubernetes-addons/Observability/README.md``.
If you do a ``make html`` without first doing a ``make clean``, there may be
files left behind from a previous build that can cause s... | ai_ref_knowledge | OPEA Documentation | path to specific file with an issue. For example, the warnings shown here indicate a heading level problem on lines 5 and 111 in ``GenAIInfra/kubernetes-addons/Observability/README.md``.
If you do a ``make html`` without first doing a ``make clean``, there may be
files left behind from a previous build that can cause s... | path to specific file with an issue. For example, the warnings shown here indicate a heading level problem on lines 5 and 111 in ``GenAIInfra/kubernetes-addons/Observability/README.md``.
If you do a ``make html`` without first doing a ``make clean``, there may be
files left behind from a previous build that can cause s... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
dd0033aa-8107-4df1-974e-1f2e1366a10a | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 6 | opea-semantic-v1 | fabaa94e0265c041 | Some content is manipulated or generated during the doc build process:
- Because markdown doesn't directly support cross-repo document linking, we use
full URLs to link to the markdown files in other project repos, for example a
link to a document in the GenAIInfra repo from a document in the GenAIExamples
repo woul... | ai_ref_knowledge | OPEA Documentation | Some content is manipulated or generated during the doc build process:
- Because markdown doesn't directly support cross-repo document linking, we use
full URLs to link to the markdown files in other project repos, for example a
link to a document in the GenAIInfra repo from a document in the GenAIExamples
repo woul... | Some content is manipulated or generated during the doc build process:
- Because markdown doesn't directly support cross-repo document linking, we use
full URLs to link to the markdown files in other project repos, for example a
link to a document in the GenAIInfra repo from a document in the GenAIExamples
repo woul... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e24eed60-e5fd-4e22-85ff-8c899638f6e7 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 21 | opea-semantic-v1 | dd120a5062b3ff31 | #. At a command prompt, create the top working folder on your development computer and clone your personal ``docs`` repository there:
cd ~
mkdir opea-project && cd opea-project
git clone https://github.com/<github-username>/docs.git | ai_ref_knowledge | OPEA Documentation | #. At a command prompt, create the top working folder on your development computer and clone your personal ``docs`` repository there:
cd ~
mkdir opea-project && cd opea-project
git clone https://github.com/<github-username>/docs.git | #. At a command prompt, create the top working folder on your development computer and clone your personal ``docs`` repository there:
cd ~
mkdir opea-project && cd opea-project
git clone https://github.com/<github-username>/docs.git | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e50882be-1a41-409a-99ed-fd93d88c85e4 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 1 | opea-semantic-v1 | 17f940347e45e6e6 | generating the OPEA project documentation and publishing it to https://opea-project.github.io. You can also use these instructions to generate the OPEA documentation on your local system.
.. rst-class:: rst-columns | ai_ref_knowledge | OPEA Documentation | generating the OPEA project documentation and publishing it to https://opea-project.github.io. You can also use these instructions to generate the OPEA documentation on your local system.
.. rst-class:: rst-columns | generating the OPEA project documentation and publishing it to https://opea-project.github.io. You can also use these instructions to generate the OPEA documentation on your local system.
.. rst-class:: rst-columns | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e5e5d422-9f74-4f9c-8ae0-ca9f46dd659d | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 48 | opea-semantic-v1 | 4cfb1d858333e53a | exists. The ``Makefile`` creates the ``_build`` folder (if it doesn't exist) and copies all needed files from these cloned repos into the ``_build/rst`` working folder.
Normally you'd have each repo checked out at the main branch before you run the
``make html`` step. The doc build process uses the five repo's contents... | ai_ref_knowledge | OPEA Documentation | exists. The ``Makefile`` creates the ``_build`` folder (if it doesn't exist) and copies all needed files from these cloned repos into the ``_build/rst`` working folder.
Normally you'd have each repo checked out at the main branch before you run the
``make html`` step. The doc build process uses the five repo's contents... | exists. The ``Makefile`` creates the ``_build`` folder (if it doesn't exist) and copies all needed files from these cloned repos into the ``_build/rst`` working folder.
Normally you'd have each repo checked out at the main branch before you run the
``make html`` step. The doc build process uses the five repo's contents... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
eb015ce2-1195-424d-9773-b88202462873 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 27 | opea-semantic-v1 | 6efdfebc544a342c | * ``GenAIComps`` * ``GenAIEval`` * ``GenAIExamples`` * ``GenAIInfra``
#. If you haven't done so already, configure git with your name
and email address for the ``Signed-off-by`` line in your commit messages: | ai_ref_knowledge | OPEA Documentation | * ``GenAIComps`` * ``GenAIEval`` * ``GenAIExamples`` * ``GenAIInfra``
#. If you haven't done so already, configure git with your name
and email address for the ``Signed-off-by`` line in your commit messages: | * ``GenAIComps`` * ``GenAIEval`` * ``GenAIExamples`` * ``GenAIInfra``
#. If you haven't done so already, configure git with your name
and email address for the ``Signed-off-by`` line in your commit messages: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
eef2da5f-4a67-4751-bcb4-b84221a152b4 | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 43 | opea-semantic-v1 | 225b2c046c72245b | sphinx version: 7.3.0 docutils version: 0.20 sphinx-rtd-theme version: 2.0.0 sphinx-tabs version: 3.4.5 myst-parser version: 3.0.1 sphinx-md version: 0.0.3 sphinxcontrib-mermaid version: 0.9.2 pymarkdownlnt version: 0.9.21
Documentation Presentation Theme
******************************** | ai_ref_knowledge | OPEA Documentation | sphinx version: 7.3.0 docutils version: 0.20 sphinx-rtd-theme version: 2.0.0 sphinx-tabs version: 3.4.5 myst-parser version: 3.0.1 sphinx-md version: 0.0.3 sphinxcontrib-mermaid version: 0.9.2 pymarkdownlnt version: 0.9.21
Documentation Presentation Theme
******************************** | sphinx version: 7.3.0 docutils version: 0.20 sphinx-rtd-theme version: 2.0.0 sphinx-tabs version: 3.4.5 myst-parser version: 3.0.1 sphinx-md version: 0.0.3 sphinxcontrib-mermaid version: 0.9.2 pymarkdownlnt version: 0.9.21
Documentation Presentation Theme
******************************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f0c2f7ac-0ae6-4772-8e2e-ee010233f2ec | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 76 | opea-semantic-v1 | 1374621bd9ff6f28 | expected. Note that the file names shown in the error/warning messages will be for files in the ``_build/rst`` folder (copied from the repos). For example,
New errors/warnings found, please fix them: | ai_ref_knowledge | OPEA Documentation | expected. Note that the file names shown in the error/warning messages will be for files in the ``_build/rst`` folder (copied from the repos). For example,
New errors/warnings found, please fix them: | expected. Note that the file names shown in the error/warning messages will be for files in the ``_build/rst`` folder (copied from the repos). For example,
New errors/warnings found, please fix them: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f829419a-7a6d-4562-96ed-4dc97521d61b | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 64 | opea-semantic-v1 | c7204470c6b48e33 | Then, after you've verified the generated HTML produced by ``make html`` looks good, you can push to the publishing site with:
make publish | ai_ref_knowledge | OPEA Documentation | Then, after you've verified the generated HTML produced by ``make html`` looks good, you can push to the publishing site with:
make publish | Then, after you've verified the generated HTML produced by ``make html`` looks good, you can push to the publishing site with:
make publish | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
f90e41f5-b7f5-4fe5-8a94-efc3ae3534ef | OPEA Documentation | file://datasets/opea-docs/developer-guides/docbuild.rst | unknown | 79ac608d-35c0-4052-8cd9-8db245f8f0a0 | 25 | opea-semantic-v1 | b46f2030658dd1f7 | #. Return to the parent directory with ``cd ..``
#. Now do the same steps (fork to your personal account, clone to your local
computer, and setup the git upstream remote) for the other four repos
replacing the docs.git repo name in the previous step
with the appropriate repo name in this list: | ai_ref_knowledge | OPEA Documentation | #. Return to the parent directory with ``cd ..``
#. Now do the same steps (fork to your personal account, clone to your local
computer, and setup the git upstream remote) for the other four repos
replacing the docs.git repo name in the previous step
with the appropriate repo name in this list: | #. Return to the parent directory with ``cd ..``
#. Now do the same steps (fork to your personal account, clone to your local
computer, and setup the git upstream remote) for the other four repos
replacing the docs.git repo name in the previous step
with the appropriate repo name in this list: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.