Skip to content

Commit

Permalink
Remove unneeded shell text block markers
Browse files Browse the repository at this point in the history
  • Loading branch information
bskinn committed May 9, 2024
1 parent b80cdf1 commit 254ccbb
Showing 1 changed file with 0 additions and 13 deletions.
13 changes: 0 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ documentation set you want to cross-reference into, and pass it to

For internal cross-references, locate `objects.inv` within `build/html`:

<!-- START TEST BLOCK -->

```none
$ sphobjinv suggest doc/build/html/objects.inv as_rst -st 58
Expand Down Expand Up @@ -76,9 +74,6 @@ Version: 2.3
:py:class:`sphobjinv.inventory.Inventory` 59
```

<!-- END TEST BLOCK -->


The `-s` argument in the above shell command indicates to print the
`fuzzywuzzy` match score along with each search result, and `-t 50`
changes the reporting threshold for the match score.
Expand All @@ -89,8 +84,6 @@ with the `--url/-u` flag. For example, say I need to know how to
cross-reference the `linspace` function from numpy (see
[here][numpy linspace]):

<!-- START TEST BLOCK -->

```none
$ sphobjinv suggest https://numpy.org/doc/1.23/reference/index.html linspace -su
Expand Down Expand Up @@ -133,8 +126,6 @@ Version: 1.23
:std:doc:`reference/generated/numpy.linspace` 90
```

<!-- END TEST BLOCK -->

**NOTE** that the results from `sphobjinv suggest` are printed using the
longer *block directives*, whereas cross-references must be composed using the
*inline directives*. Thus, the above `linspace()` function must be
Expand All @@ -147,16 +138,12 @@ cross-referenced as ``` :func:`numpy.linspace` ``` , **not**

`objects.inv` files can be decompressed to plaintext at the commandline:

<!-- START TEST BLOCK -->

```none
$ sphobjinv convert plain -o doc/build/html/objects.inv doc/scratch/
Conversion completed.
'...objects.inv' converted to '...objects.txt' (plain).
```

<!-- END TEST BLOCK -->

JSON output is supported (`sphobjinv convert json ...`), and
inventories can be re-compressed to the
partially-zlib-compressed form that `intersphinx` reads
Expand Down

0 comments on commit 254ccbb

Please sign in to comment.