Skip to content

Commit 53598a4

Browse files
committed
Improve sphinx doc formatting
1 parent 4863e14 commit 53598a4

4 files changed

Lines changed: 24 additions & 13 deletions

File tree

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ clean:
5050
dist: check-rst
5151
bash ./admin-tools/make-dist-newer.sh
5252

53+
#: HTML document via Sphinx
54+
doc html htmldoc:
55+
$(MAKE) -C docs html
56+
5357
#: Create source tarball
5458
sdist: check-rst
5559
$(PYTHON) ./setup.py sdist

docs/commands/set/asmfmt.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,17 @@ Set Asmfmt
88

99
Set the style of format to use in disassembly:
1010

11-
classic: fields: line, marker offset, opcode operand
12-
extended: above, but we try harder to get operand information from previous instructions
13-
bytes: like classic but we show the instruction bytes after the offset
14-
extended-bytes: bytes + extended
11+
``classic``:
12+
has fields: *line* *marker* *offset*, and *opcode operand*
13+
14+
``extended``:
15+
like ``classic``, but we try harder to get operand information from previous instructions
16+
17+
``bytes``:
18+
like classic but we show the instruction bytes after the offset
19+
20+
``extended-bytes``
21+
``bytes`` format along with *extended* format
1522

1623

1724
Examples:
@@ -23,4 +30,4 @@ Examples:
2330

2431
.. seealso::
2532

26-
:ref:`show asmfmt <show_asmfmt>``
33+
:ref:`show asmfmt <show_asmfmt>`

docs/commands/set/events.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ Sets the events that the debugger will stop on. Event names are:
1010
.. hlist::
1111
:columns: 3
1212

13-
* `c_call`
14-
* `c_exception`
15-
* `c_return`
16-
* `call`
17-
* `exception`
18-
* `line`
19-
* `return`
13+
* ``c_call``
14+
* ``c_exception``
15+
* ``c_return``
16+
* `call``
17+
* ``exception``
18+
* ``line``
19+
* ``return``
2020

2121
`all` can be used as an abbreviation for listing all event names.
2222

docs/commands/show/asmfmt.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Example:
1616

1717
.. seealso::
1818

19-
:ref:`set_asmfmt <set_asmfmt>``
19+
:ref:`set_asmfmt <set_asmfmt>`

0 commit comments

Comments
 (0)