Skip to content

Commit ffb98cd

Browse files
committed
Fixes to RST in docs
1 parent 86290a1 commit ffb98cd

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

docs/contributing.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ All improvements to the software should start with an issue. Read `How I build a
1313
Obtaining the code
1414
==================
1515

16-
To work on this library locally, first checkout the code.
16+
To work on this library locally, first checkout the code::
1717

1818
git clone [email protected]:simonw/sqlite-utils
1919
cd sqlite-utils
2020

21-
Use `uv run` to run the development version of the tool:
21+
Use ``uv run`` to run the development version of the tool::
2222

2323
uv run sqlite-utils --help
2424

@@ -27,7 +27,7 @@ Use `uv run` to run the development version of the tool:
2727
Running the tests
2828
=================
2929

30-
Use `uv run` to run the tests:
30+
Use ``uv run`` to run the tests::
3131

3232
uv run pytest
3333

@@ -42,9 +42,6 @@ To build the documentation run this command::
4242

4343
This will start a server on port 8000 that will serve the documentation and live-reload any time you make an edit to a ``.rst`` file.
4444

45-
cd docs
46-
make livehtml
47-
4845
The `cog <https://github.com/nedbat/cog>`__ tool is used to maintain portions of the documentation. You can run it like so::
4946

5047
uv run cog -r docs/*.rst
@@ -54,7 +51,7 @@ The `cog <https://github.com/nedbat/cog>`__ tool is used to maintain portions of
5451
Linting and formatting
5552
======================
5653

57-
``sqlite-utils`` uses `Black <https://black.readthedocs.io/>`__ for code formatting, and `flake8 <https://flake8.pycqa.org/>`__ and `mypy <https://mypy.readthedocs.io/>`__ for linting and type checking.
54+
``sqlite-utils`` uses `Black <https://black.readthedocs.io/>`__ for code formatting, and `flake8 <https://flake8.pycqa.org/>`__ and `mypy <https://mypy.readthedocs.io/>`__ for linting and type checking::
5855

5956
uv run black .
6057

@@ -67,10 +64,10 @@ All three of these tools are run by our CI mechanism against every commit and pu
6764

6865
.. _contributing_just:
6966

70-
Using Just and uv
71-
=================
67+
Using Just
68+
==========
7269

73-
If you install `Just <https://github.com/casey/just>`__ and `uv <https://github.com/astral-sh/uv>`__ you can use them to manage your local development environment.
70+
If you install `Just <https://github.com/casey/just>`__ you can use it to manage your local development environment.
7471

7572
To run all of the tests and linters::
7673

0 commit comments

Comments
 (0)