Commit 46971b9d by Mathieu Kniewallner Committed by GitHub

Fix headers in documentation (#5781)

* doc(cli): move `Options` headers one level down for `self`

* doc(cli): remove backticks in headers for consistency
parent 865aa94d
...@@ -712,7 +712,7 @@ poetry cache clear pypi:requests:2.24.0 ...@@ -712,7 +712,7 @@ poetry cache clear pypi:requests:2.24.0
The `source` namespace regroups sub commands to manage repository sources for a Poetry project. The `source` namespace regroups sub commands to manage repository sources for a Poetry project.
### `source add` ### source add
The `source add` command adds source configuration to the project. The `source add` command adds source configuration to the project.
...@@ -735,7 +735,7 @@ You cannot use the name `pypi` as it is reserved for use by the default PyPI sou ...@@ -735,7 +735,7 @@ You cannot use the name `pypi` as it is reserved for use by the default PyPI sou
You cannot set a source as both `default` and `secondary`. You cannot set a source as both `default` and `secondary`.
{{% /note %}} {{% /note %}}
### `source show` ### source show
The `source show` command displays information on all configured sources for the project. The `source show` command displays information on all configured sources for the project.
...@@ -753,7 +753,7 @@ poetry source show pypi-test ...@@ -753,7 +753,7 @@ poetry source show pypi-test
This command will only show sources configured via the `pyproject.toml` and does not include PyPI. This command will only show sources configured via the `pyproject.toml` and does not include PyPI.
{{% /note %}} {{% /note %}}
### `source remove` ### source remove
The `source remove` command removes a configured source from your `pyproject.toml`. The `source remove` command removes a configured source from your `pyproject.toml`.
...@@ -812,7 +812,7 @@ Use of these commands will create the required `pyproject.toml` and `poetry.lock ...@@ -812,7 +812,7 @@ Use of these commands will create the required `pyproject.toml` and `poetry.lock
[configuration directory]({{< relref "configuration" >}}). [configuration directory]({{< relref "configuration" >}}).
{{% /note %}} {{% /note %}}
### `self add` ### self add
The `self add` command installs Poetry plugins and make them available at runtime. Additionally, it can The `self add` command installs Poetry plugins and make them available at runtime. Additionally, it can
also be used to upgrade Poetry's own dependencies or inject additional packages into the runtime also be used to upgrade Poetry's own dependencies or inject additional packages into the runtime
...@@ -844,7 +844,7 @@ To add a keyring provider `artifacts-keyring`, you can run: ...@@ -844,7 +844,7 @@ To add a keyring provider `artifacts-keyring`, you can run:
poetry self add artifacts-keyring poetry self add artifacts-keyring
``` ```
### Options #### Options
* `--editable (-e)`: Add vcs/path dependencies as editable. * `--editable (-e)`: Add vcs/path dependencies as editable.
* `--extras (-E)`: Extras to activate for the dependency. (multiple values allowed) * `--extras (-E)`: Extras to activate for the dependency. (multiple values allowed)
...@@ -852,7 +852,7 @@ poetry self add artifacts-keyring ...@@ -852,7 +852,7 @@ poetry self add artifacts-keyring
* `--source`: Name of the source to use to install the package. * `--source`: Name of the source to use to install the package.
* `--dry-run`: Output the operations but do not execute anything (implicitly enables --verbose). * `--dry-run`: Output the operations but do not execute anything (implicitly enables --verbose).
### `self update` ### self update
The `self update` command updates Poetry version in its current runtime environment. The `self update` command updates Poetry version in its current runtime environment.
...@@ -865,12 +865,12 @@ is different in that the packages managed are for Poetry's runtime environment. ...@@ -865,12 +865,12 @@ is different in that the packages managed are for Poetry's runtime environment.
poetry self update poetry self update
``` ```
### Options #### Options
* `--preview`: Allow the installation of pre-release versions. * `--preview`: Allow the installation of pre-release versions.
* `--dry-run`: Output the operations but do not execute anything (implicitly enables --verbose). * `--dry-run`: Output the operations but do not execute anything (implicitly enables --verbose).
### `self lock` ### self lock
The `self lock` command reads this Poetry installation's system `pyproject.toml` file. The system The `self lock` command reads this Poetry installation's system `pyproject.toml` file. The system
dependencies are locked in the corresponding `poetry.lock` file. dependencies are locked in the corresponding `poetry.lock` file.
...@@ -879,12 +879,12 @@ dependencies are locked in the corresponding `poetry.lock` file. ...@@ -879,12 +879,12 @@ dependencies are locked in the corresponding `poetry.lock` file.
poetry self lock poetry self lock
``` ```
### Options #### Options
* `--check`: Verify that `poetry.lock` is consistent with `pyproject.toml` * `--check`: Verify that `poetry.lock` is consistent with `pyproject.toml`
* `--no-update`: Do not update locked versions, only refresh lock file. * `--no-update`: Do not update locked versions, only refresh lock file.
### `self show` ### self show
The `self show` command behaves similar to the show command, but The `self show` command behaves similar to the show command, but
working within Poetry's runtime environment. This lists all packages installed within working within Poetry's runtime environment. This lists all packages installed within
...@@ -897,14 +897,14 @@ dependencies use `self show --addons`. ...@@ -897,14 +897,14 @@ dependencies use `self show --addons`.
poetry self show poetry self show
``` ```
### Options #### Options
* `--addons`: List only add-on packages installed. * `--addons`: List only add-on packages installed.
* `--tree`: List the dependencies as a tree. * `--tree`: List the dependencies as a tree.
* `--latest (-l)`: Show the latest version. * `--latest (-l)`: Show the latest version.
* `--outdated (-o)`: Show the latest version but only for packages that are outdated. * `--outdated (-o)`: Show the latest version but only for packages that are outdated.
### `self show plugins` ### self show plugins
The `self show plugins` command lists all the currently installed plugins. The `self show plugins` command lists all the currently installed plugins.
...@@ -912,7 +912,7 @@ The `self show plugins` command lists all the currently installed plugins. ...@@ -912,7 +912,7 @@ The `self show plugins` command lists all the currently installed plugins.
poetry self show plugins poetry self show plugins
``` ```
### `self remove` ### self remove
The `self remove` command removes an installed addon package. The `self remove` command removes an installed addon package.
...@@ -924,7 +924,7 @@ poetry self remove poetry-plugin-export ...@@ -924,7 +924,7 @@ poetry self remove poetry-plugin-export
* `--dry-run`: Outputs the operations but will not execute anything (implicitly enables --verbose). * `--dry-run`: Outputs the operations but will not execute anything (implicitly enables --verbose).
### `self install` ### self install
The `self install` command ensures all additional packages specified are installed in the current The `self install` command ensures all additional packages specified are installed in the current
runtime environment. runtime environment.
...@@ -938,7 +938,7 @@ is different in that the packages managed are for Poetry's runtime environment. ...@@ -938,7 +938,7 @@ is different in that the packages managed are for Poetry's runtime environment.
poetry self install --sync poetry self install --sync
``` ```
### Options #### Options
* `--sync`: Synchronize the environment with the locked packages and the specified groups. * `--sync`: Synchronize the environment with the locked packages and the specified groups.
* `--dry-run`: Output the operations but do not execute anything (implicitly enables --verbose). * `--dry-run`: Output the operations but do not execute anything (implicitly enables --verbose).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment