Skip to content

Commit 5b727b7

Browse files
committed
Rework the project's documentation
This migrates all the documentation into Sphinx, and uses automation to document various pieces of functionality.
1 parent fb7d270 commit 5b727b7

File tree

17 files changed

+239
-473
lines changed

17 files changed

+239
-473
lines changed

.prettierrc.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
proseWrap = "always"

.readthedocs.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
3+
build:
4+
os: "ubuntu-20.04"
5+
tools:
6+
python: "3.10"
7+
8+
sphinx:
9+
configuration: docs/conf.py
10+
11+
python:
12+
install:
13+
- requirements: docs/requirements.txt
14+
- method: pip
15+
path: .

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# LiveReload
2+
3+
Reload webpages on changes, without hitting refresh in your browser.
4+
5+
## Installation
6+
7+
<!-- start install -->
8+
9+
LiveReload is for web developers who know Python. It is available on [PyPI].
10+
11+
```
12+
$ pip install livereload
13+
```
14+
15+
[pypi]: https://pypi.python.org/pypi/livereload
16+
17+
<!-- end install -->
18+
19+
## Documentation
20+
21+
[LiveReload's documentation is hosted on ReadTheDocs][docs].
22+
23+
[docs]: https://livereload.readthedocs.io/en/latest/
24+
25+
## Security Report
26+
27+
To report a security vulnerability, please use the [Tidelift security contact].
28+
Tidelift will coordinate the fix and disclosure.
29+
30+
[tidelift security contact]: https://tidelift.com/security

README.rst

Lines changed: 0 additions & 197 deletions
This file was deleted.

docs/_templates/sidebarintro.html

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/_themes

Submodule _themes deleted from 6298bdf

docs/api.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
=============
2+
API Reference
3+
=============
4+
5+
Helper Functions
6+
================
7+
8+
.. autoclass:: livereload.shell
9+
:members:
10+
11+
Server
12+
======
13+
14+
.. autoclass:: livereload.Server
15+
:members:

docs/cli.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Command Line Interface
2+
3+
The `livereload` command can be used for starting a live-reloading server, that
4+
serves a directory.
5+
6+
```{command-output} livereload --help
7+
8+
```
9+
10+
It will listen to port 35729 by default, since that's the usual port for
11+
[LiveReload browser extensions].
12+
13+
[livereload browser extensions]: https://livereload.com/extensions/
14+
15+
```{versionchanged} 2.0.0
16+
`Guardfile` is no longer supported. Write a Python script using the API instead.
17+
```

0 commit comments

Comments
 (0)