Commit Graph

10 Commits

Author SHA1 Message Date
Alex Osborne fee534c3db docs: Get version from pom.xml 2025-05-13 14:15:20 +09:00
Alex Osborne 88854d8dfd Add caption to deciderule extlinks
It seems to be failing because the placeholder is missing:

```
  File "/home/docs/checkouts/readthedocs.org/user_builds/heritrix/envs/latest/lib/python3.12/site-packages/sphinx/ext/extlinks.py", line 103, in role
    title = caption % part
            ~~~~~~~~^~~~~~
TypeError: not all arguments converted during string formatting
```
2025-02-14 11:23:02 +09:00
Alex Osborne d10be35f0c docs: Remove duplicate word 'Documentation' from page titles
Also include '3' to distinguish from the Heritrix 1 manual which is
still prevalent in search results.
2021-07-12 09:10:57 +09:00
Alex Osborne c2c2b244de docs: Add a plugin for basic auto-generation of bean examples 2021-07-10 21:09:17 +09:00
Alex Osborne 9b1919dbd3 docs: Remove inaccurate 2018 date from documentation footer
Large portions of the docs were first published much earlier in other
places and some have been updated since then. Rather than trying to
keep a date range up to date let's just remove the date. We don't use
dates in the source code boilerplate and my understanding is copyright
notices are not mandatory in almost all countries due to the Berne
Convention anyway so it's really just informational.
2021-07-10 12:37:35 +09:00
Alex Osborne a84e0bb792 docs: Add an operating guide based on the contents of the wiki 2021-07-07 21:30:36 +09:00
Alex Osborne 507d7d91a3 docs: add getting-started.rst, configuring-jobs.rst and glossary.rst
Compiled from the wiki with some restructuring, reformatting and
updating for the current version of Heritrix.
2021-07-06 22:44:11 +09:00
Alex Osborne 1ff31c135e Add explanatory note about documentation 2018-07-04 19:48:33 +09:00
Alex Osborne ab8a5efea2 Format HTTP request lines in API guide 2018-07-04 18:24:08 +09:00
Alex Osborne 90db2e33d5 Add skeleton sphinx docs for readthedocs 2018-07-04 16:40:51 +09:00