Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fix] Update up docs, build instructions #3201

Merged
merged 1 commit into from
Aug 12, 2024
Merged

[fix] Update up docs, build instructions #3201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ These command will create a folder named `ComponentName` with all the necessary
Aim documentation is built using [Sphix](https://www.sphinx-doc.org) and is hosted at
[Read the Docs](https://aimstack.readthedocs.io).
The documentation sources are located at `docs/` directory. In order to build documentation locally
run the following commands
run the following commands with a Python interpreter version <= 3.10:
```shell
pip install -r requirements.dev.txt
cd docs
Expand Down
2 changes: 0 additions & 2 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@ sphinx_rtd_theme
m2r2==0.3.3.post2
sphinx-copybutton
Cython==3.0.10

-r ./../requirements.txt
10 changes: 5 additions & 5 deletions docs/source/refs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ $ aim up [ARGS]

| Args | Description |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `-h` &#124; `--host <host>` | Specify host address. |
| `-p` &#124; `--port <port>` | Specify port to listen to. |
| `-h, --host <host>` | Specify host address. |
| `-p, --port <port>` | Specify port to listen to. _Default is 43800._ |
| `--repo <repo_path>` | Path to parent directory of `.aim` repo. _Current working directory by default_. |
| `--dev` | Run UI in development mode. |
| `--dev` | Run UI in development mode—enables hot-reloading only, _not meant for end-users_. |
| `--profiler` | Enables API profiling which logs run trace inside `.aim/profiler` directory. |
| `--log-level` | Specifies log level for python logging package. _`WARNING` by default, `DEBUG` when `--dev` option is provided_. |

Expand All @@ -71,8 +71,8 @@ $ aim server [ARGS]
| Args | Description |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `--repo <repo_path>` | Path to parent directory of `.aim` repo. _Current working directory by default_. |
| `-h` &#124; `--host <host>` | Specify host address. |
| `-p` &#124; `--port <port>` | Specify port to listen to. _Default is 53800_. |
| `-h, --host <host>` | Specify host address. |
| `-p, --port <port>` | Specify port to listen to. _Default is 53800_. |
| `--ssl-keyfile` | Specify path to keyfile for secure connection. |
| `--ssl-certfile` | Specify path to cert. file for secure connection. |
| `--dev` | Run UI in development mode. |
Expand Down