Simon Willison
4fe1765dc3
Add test for RST heading underline lengths, closes #2544
...
Added test_rst_heading_underlines_match_title_length() to verify that RST
heading underlines match their title lengths. The test properly handles:
- Overline+underline style headings (skips validation for those)
- Empty lines before underlines (ignores them)
- Minimum 5-character underline length (avoids false positives)
Running this test identified 14 heading underline mismatches which have
been fixed across 5 documentation files:
- docs/authentication.rst (3 headings)
- docs/plugin_hooks.rst (4 headings)
- docs/internals.rst (5 headings)
- docs/deploying.rst (1 heading)
- docs/changelog.rst (1 heading)
🤖 Generated with [Claude Code](https://claude.com/claude-code )
Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-26 09:49:49 -07:00
Simon Willison
943df09dcc
Remove all remaining "$ " prefixes from docs, closes #2140
...
Also document sqlite-utils create-view
2023-08-11 10:44:34 -07:00
Adam Simpson
984b1df12c
Add documentation for serving via OpenRC ( #1825 )
...
* Add documentation for serving via OpenRC
2022-09-27 21:21:36 -07:00
Simon Willison
d8c79b1340
Link to Apache proxy demo from documentation, closes #1524
2021-11-20 15:33:58 -08:00
Simon Willison
2208c3c68e
Spelling corrections plus CI job for codespell
...
* Use codespell to check spelling in documentation, refs #1417
* Fixed spelling errors spotted by codespell, closes #1417
* Make codespell a docs dependency
See also this TIL: https://til.simonwillison.net/python/codespell
2021-08-03 09:36:38 -07:00
Simon Willison
ba11ef27ed
Clarify when to use systemd restart
2021-07-13 22:43:13 -07:00
Simon Willison
2c4cd7141a
Consistently use /my-datasette in examples
2021-07-13 16:15:48 -07:00
Simon Willison
7f4c854db1
rST fix
2021-07-13 11:45:32 -07:00
Aslak Raanes
d71cac4981
How to configure Unix domain sockets with Apache
...
Example on how to use Unix domain socket option on Apache. Not testet.
(Usually I would have used [`ProxyPassReverse`](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse ) in combination with `ProxyPass` , i.e.
```apache
ProxyPass /my-datasette/ http://127.0.0.1:8009/my-datasette/
ProxyPassReverse /my-datasette/ http://127.0.0.1:8009/my-datasette/
```
and
```apache
ProxyPass /my-datasette/ unix:/tmp/datasette.sock|http://localhost/my-datasette/
ProxyPassReverse /my-datasette/ unix:/tmp/datasette.sock|http://localhost/my-datasette/
```
2021-07-13 11:32:49 -07:00
Aslak Raanes
4054e96a39
Update deploying.rst ( #1392 )
...
Use same base url for Apache as in the example
2021-07-13 10:42:27 -07:00
Simon Willison
d792fc7cf5
Simplified nginx config examples
2021-07-10 17:29:42 -07:00
Simon Willison
180c7a5328
--uds option for binding to Unix domain socket, closes #1388
2021-07-10 16:37:30 -07:00
Simon Willison
c8feaf0b62
systemctl restart datasette.service, closes #1390
2021-07-09 09:32:32 -07:00
Simon Willison
dbc61a1fd3
Documented ProxyPreserveHost On for Apache, closes #1387
2021-07-02 10:33:03 -07:00
Jean-Baptiste Pressac
a1bcd2fbe5
Minor typo in IP adress ( #1256 )
...
127.0.01 replaced by 127.0.0.1
2021-03-10 10:26:39 -08:00
David Boucha
4f9a2f1f47
Fix small typo ( #1243 )
...
Thanks, @UtahDave
2021-03-03 21:46:10 -08:00
Simon Willison
4c0995ed60
Fixed bug in example nginx config, refs #1091
2021-01-07 15:42:14 -08:00
Simon Willison
50cc6af016
Fixed some broken internal links, refs #1106
2020-11-28 15:34:56 -08:00
Simon Willison
5a77f7a649
Updated docs renaming config to settings
...
- config.html is now settings.html
- ConfigOption in app.py is now Setting
- updated documentation unit tests
Refs #1106
2020-11-24 13:22:33 -08:00
Simon Willison
5eb8e9bf25
Removed words that minimize involved difficulty, closes #1089
2020-11-12 12:07:19 -08:00
Simon Willison
1fe15f4dc1
Docs: Running Datasette behind a proxy, closes #1027
2020-10-31 14:13:57 -07:00
Simon Willison
703439bdc3
Don't suggest datasette-graphql in bulidpacks demo
...
Refs #997 - it's not a great suggestion because the fivethirtyeight.db
database has so many tables.
2020-10-08 16:50:43 -07:00
Simon Willison
7a029d1eda
Link to hosting providers, refs #997
2020-10-08 16:36:22 -07:00
Simon Willison
e4f18fbd37
Deploying using buildpacks docs, closes #997
2020-10-08 16:32:04 -07:00
Simon Willison
2458d7b766
Docs on deploying with systemd, refs #514
2020-10-08 15:47:37 -07:00