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.

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

Add Command Line Reference section to docs #1934

Merged
merged 3 commits into from
Jul 24, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
10 changes: 10 additions & 0 deletions docs/cli-reference/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CLI Reference
atugushev marked this conversation as resolved.
Show resolved Hide resolved

This page provides a reference for the `pip-tools` command-line interface (CLI):

```{toctree}
:maxdepth: 1

pip-compile
pip-sync
```
5 changes: 5 additions & 0 deletions docs/cli-reference/pip-compile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# pip-compile

```{program-output} pip-compile --help

```
5 changes: 5 additions & 0 deletions docs/cli-reference/pip-sync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# pip-sync

```{program-output} pip-sync --help

```
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["myst_parser"]
extensions = ["myst_parser", "sphinxcontrib.programoutput"]


# -- Options for HTML output -------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
:maxdepth: 2
:caption: Contents

cli-reference/index
contributing
changelog
```
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ furo >= 2021.7.5b38
myst-parser >= 0.15.1
setuptools-scm >= 6.0.1
Sphinx >= 4.1.1
sphinxcontrib-programoutput >= 0.17