-
Notifications
You must be signed in to change notification settings - Fork 107
[DOCS] move rvc folder #2208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
[DOCS] move rvc folder #2208
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
9d407f4
move rvc folder
swpng 39ccb08
Update index.rst
swpng 4c047bc
move the doxygen folder back to the original location
swpng 67cc160
resolve conflicts in file
swpng f3e1e5e
Merge branch 'main' into move_rvc_folder
swpng 161545e
update links
swpng 7504cc0
Merge branch 'main' into move_rvc_folder
swpng 1fde66b
Update components.rst
swpng 28ec70b
Update components.rst
swpng 79fad49
Merge branch 'main' into move_rvc_folder
swpng 2b3970f
Apply suggestion from @sgolebiewski-intel
sgolebiewski-intel 03131fd
Merge branch 'main' into move_rvc_folder
swpng File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,3 @@ | ||
| # Robotic Vision & Control [RVC] Documentation | ||
|
|
||
| This directory contains the **Robotic Vision & Control [RVC]** system documentation, which is built from source using [Sphinx](https://www.sphinx-doc.org/). The following instructions will guide you through setting up the environment, installing dependencies, and building the HTML documentation. | ||
|
|
||
| --- | ||
|
|
||
| ## 1. Install System Dependencies | ||
|
|
||
| Before setting up the Python environment, ensure that essential system packages are installed. These packages include: | ||
|
|
||
| * `python3-pip` – for installing Python packages | ||
| * `graphviz` – for rendering diagrams in Sphinx | ||
| * `libenchant-2-dev` – required by spelling check extensions | ||
|
|
||
|
|
||
| ```bash | ||
| sudo apt update | ||
| sudo apt install python3-pip | ||
| sudo apt install graphviz libenchant-2-dev | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 2. Set Up a Python Virtual Environment | ||
|
|
||
| Though not necessary, it is recommended to use a virtual environment to keep dependencies isolated. | ||
|
|
||
| ```bash | ||
| # Navigate to the documentation folder | ||
| export DOCS_DIR=<path to edge-ai-suites folder> | ||
| cd $DOCS_DIR/edge-ai-suites/robotics-ai-suite/robot-vision-control/docs | ||
|
|
||
| # Create a new virtual environment | ||
| python3 -m venv venv_robotics-ai-suite-docs | ||
|
|
||
| # Activate the virtual environment | ||
| source venv_robotics-ai-suite-docs/bin/activate | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 3. Upgrade pip, setuptools, and wheel | ||
|
|
||
| Inside the virtual environment, upgrade core Python packaging tools. This ensures compatibility with modern packages. | ||
|
|
||
| ```bash | ||
| pip install --upgrade pip setuptools wheel | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 4. Install Python Dependencies | ||
|
|
||
| With the virtual environment active, install all Python dependencies required to build the documentation: | ||
|
|
||
| ```bash | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| Now reactivate the virtual environment: | ||
|
|
||
| ```bash | ||
| source venv_robotics-ai-suite-docs/bin/activate | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 5. Build HTML Documentation | ||
|
|
||
| Once dependencies are installed and the virtual environment is active, generate the HTML version of the documentation: | ||
|
|
||
| ```bash | ||
| make html | ||
| ``` | ||
|
|
||
| The output will be available in the `build/html` folder inside your `docs` directory. You can open the `index.html` file in a browser to view the documentation. | ||
|
|
||
| --- | ||
| The documentation files are at https://github.com/open-edge-platform/edge-ai-suites/tree/main/robotics-ai-suite/docs/rvc. |
10 changes: 0 additions & 10 deletions
10
robotics-ai-suite/robot-vision-control/docs/requirements.txt
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/images
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
robotics-ai-suite/robot-vision-control/docs/source/use_cases/images
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.