Skip to content
This repository was archived by the owner on May 21, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
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
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ docker-build-proto:

src/python_pachyderm/proto/v2: docker-build-proto
@echo "Building with pachyderm core v$(PACHYDERM_VERSION)"
rm -rf src/python_pachyderm/proto/v2
rm -rf src/python_pachyderm/proto/v2 && \
rm -rf src/python_pachyderm/experimental/proto/v2
cd proto/pachyderm && \
git fetch --all && \
git checkout v$(PACHYDERM_VERSION)
Expand Down
22 changes: 20 additions & 2 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,31 @@ make lint

## Rebuilding API docs

We use [pdoc3](https://github.com/pdoc3/pdoc) to generate our API docs site.
To rebuild the docs, run
We use Sphinx to generate our API docs site.

**If you added any new files or modules** that you want included in the docs
site, you must first create the RST files for them so Sphinx can reference and
include them. To create these RST files, run:

```bash
sphinx-apidoc -o source ../src/
```

You'll see the new RST file(s) in `docs/source`. Make sure to add the reference
to these new file(s) in the other RST files.

Additionally, add any new libraries to `docs/requirements.txt` that are
needed to build the docs.

To rebuild the docs, run:

```bash
make docs
```

This is a great way to check locally that the docs look as you expect them
before you make a commit or release.

## Releasing

Our current process for publishing a release of python-pachyderm consists of the following steps:
Expand Down
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/modules.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/python_pachyderm.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/python_pachyderm.mixin.doctree
Binary file not shown.
1,418 changes: 1,418 additions & 0 deletions docs/build/html/_modules/betterproto.html

Large diffs are not rendered by default.

25 changes: 24 additions & 1 deletion docs/build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<p class="caption" role="heading"><span class="caption-text">Docs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../python_pachyderm.html">python_pachyderm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../modules.html">python_pachyderm</a></li>
</ul>

</div>
Expand Down Expand Up @@ -65,6 +65,29 @@

<h1>All modules for which code is available</h1>
<ul><li><a href="python_pachyderm/client.html">python_pachyderm.client</a></li>
<li><a href="python_pachyderm/experimental/client.html">python_pachyderm.experimental.client</a></li>
<li><a href="python_pachyderm/experimental/mixin/admin.html">python_pachyderm.experimental.mixin.admin</a></li>
<li><a href="python_pachyderm/experimental/mixin/auth.html">python_pachyderm.experimental.mixin.auth</a></li>
<li><a href="python_pachyderm/experimental/mixin/debug.html">python_pachyderm.experimental.mixin.debug</a></li>
<li><a href="python_pachyderm/experimental/mixin/enterprise.html">python_pachyderm.experimental.mixin.enterprise</a></li>
<li><a href="python_pachyderm/experimental/mixin/health.html">python_pachyderm.experimental.mixin.health</a></li>
<li><a href="python_pachyderm/experimental/mixin/identity.html">python_pachyderm.experimental.mixin.identity</a></li>
<li><a href="python_pachyderm/experimental/mixin/license.html">python_pachyderm.experimental.mixin.license</a></li>
<li><a href="python_pachyderm/experimental/mixin/pfs.html">python_pachyderm.experimental.mixin.pfs</a></li>
<li><a href="python_pachyderm/experimental/mixin/pps.html">python_pachyderm.experimental.mixin.pps</a></li>
<li><a href="python_pachyderm/experimental/mixin/transaction.html">python_pachyderm.experimental.mixin.transaction</a></li>
<li><a href="python_pachyderm/experimental/mixin/version.html">python_pachyderm.experimental.mixin.version</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/admin_v2.html">python_pachyderm.experimental.proto.v2.admin_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/auth_v2.html">python_pachyderm.experimental.proto.v2.auth_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/debug_v2.html">python_pachyderm.experimental.proto.v2.debug_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/enterprise_v2.html">python_pachyderm.experimental.proto.v2.enterprise_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/identity_v2.html">python_pachyderm.experimental.proto.v2.identity_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/license_v2.html">python_pachyderm.experimental.proto.v2.license_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/pfs_v2.html">python_pachyderm.experimental.proto.v2.pfs_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/pps_v2.html">python_pachyderm.experimental.proto.v2.pps_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/proxy.html">python_pachyderm.experimental.proto.v2.proxy</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/transaction_v2.html">python_pachyderm.experimental.proto.v2.transaction_v2</a></li>
<li><a href="python_pachyderm/experimental/proto/v2/versionpb_v2.html">python_pachyderm.experimental.proto.v2.versionpb_v2</a></li>
<li><a href="python_pachyderm/mixin/admin.html">python_pachyderm.mixin.admin</a></li>
<li><a href="python_pachyderm/mixin/auth.html">python_pachyderm.mixin.auth</a></li>
<li><a href="python_pachyderm/mixin/debug.html">python_pachyderm.mixin.debug</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_modules/python_pachyderm/client.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<p class="caption" role="heading"><span class="caption-text">Docs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../python_pachyderm.html">python_pachyderm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../modules.html">python_pachyderm</a></li>
</ul>

</div>
Expand Down
Loading