Skip to content

Commit

Permalink
[docs] update sphobjinv CLI invocations to match v2.0 syntax (#80)
Browse files Browse the repository at this point in the history
  • Loading branch information
bskinn authored and svenevs committed Oct 20, 2019
1 parent 17b7540 commit 58c6c77
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/_intersphinx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Use the tool `sphobjinv` to do this (`pip install sphobjinv`).
2. Converted that bad boy to human readable (the file `bs4_objects.txt`).

```console
$ sphobjinv decode bs4_objects.inv bs4_objects.txt
$ sphobjinv convert plain bs4_objects.inv bs4_objects.txt
```

3. Any time I have a class I want to add a reference for, just add that line to
Expand All @@ -38,7 +38,7 @@ Use the tool `sphobjinv` to do this (`pip install sphobjinv`).
4. When you add a new line, simply run (assuming you are in this directory)

```console
$ sphobjinv encode bs4_objects.txt bs4_objects.inv
$ sphobjinv convert zlib bs4_objects.txt bs4_objects.inv
```

5. Re-run sphinx, usually you need to clean it for the doctree index to be rebuilt.
Expand Down

0 comments on commit 58c6c77

Please sign in to comment.