Skip to content

Commit

Permalink
Fix doc formatting
Browse files Browse the repository at this point in the history
- The shebang from conf.py has been removed from the sphinx template and
  isn't used anyway.
- Code has to have two backticks
  • Loading branch information
phibos committed Sep 13, 2024
1 parent ce8ccb7 commit 80df5a1
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# If your documentation needs a minimal Sphinx version, state it here.
Expand Down
4 changes: 2 additions & 2 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ Limitations
Requirements
------------

* Python 3, with sufficiently recent versions of `pip` and `setuptools`
* Python 3, with sufficiently recent versions of ``pip`` and ``setuptools``
* Mock (for runing unit tests).
* `qemu` for running integration tests.
* ``qemu`` for running integration tests.
4 changes: 2 additions & 2 deletions docs/query.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Syntax is very simmilar to a SQL query.
Above code demonstrates how to select ``name``, ``disabled`` fields where each interface is disabled
and ``name`` is equal to one of ``ether2``, ``wlan-lan``.
If you do not specify any logical operation within `where()`, them it defaults to `And()`.
Above example can be rewritten using `In` operator.
If you do not specify any logical operation within ``where()``, them it defaults to `And()`.
Above example can be rewritten using ``In`` operator.

.. code-block:: python
Expand Down

0 comments on commit 80df5a1

Please sign in to comment.