http://hg.code.sf.net:8000/p/roundup/code/atom-log/tip/doc/conf.py Mercurial Repository: p/roundup/code: doc/conf.py history 2025-07-11T22:25:54-04:00 build: add autodoc to sphinx extension list http://hg.code.sf.net:8000/p/roundup/code/#changeset-b0539a19ca6599aa2277ac4519124d62f0820cea John Rouillard rouilj@ieee.org 2025-07-11T22:25:54-04:00 2025-07-11T22:25:54-04:00
changeset b0539a19ca65
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description build: add autodoc to sphinx extension list

Build python class docs for packaged docs.
files
chore: it's 2025, update copyrights http://hg.code.sf.net:8000/p/roundup/code/#changeset-c80de1b0dd83afb8474277cbcb3a036ce691a79c John Rouillard rouilj@ieee.org 2025-01-01T09:54:32-05:00 2025-01-01T09:54:32-05:00
changeset c80de1b0dd83
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description chore: it's 2025, update copyrights
files
docs: update copyright to 2024. http://hg.code.sf.net:8000/p/roundup/code/#changeset-92367689600aeeb980a63995e95da6ed8aa77c38 John Rouillard rouilj@ieee.org 2024-09-25T21:33:13-04:00 2024-09-25T21:33:13-04:00
changeset 92367689600a
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description docs: update copyright to 2024.
files
docs: do not create CVE.html when processing doc for release http://hg.code.sf.net:8000/p/roundup/code/#changeset-34d5c1303a2ea30aea6fde3dc72c80eb7501d09e John Rouillard rouilj@ieee.org 2024-07-09T22:13:25-04:00 2024-07-09T22:13:25-04:00
changeset 34d5c1303a2e
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description docs: do not create CVE.html when processing doc for release

CVE.html is only needed for non-release docs. Since the doc directory
is only processed directly for releases, the CVE.txt file should be
ignored/excluded.
files
doc: add html versions of man pages http://hg.code.sf.net:8000/p/roundup/code/#changeset-e3b34d02c61a758eefbfe3dfa549d4fefa123cbe John Rouillard rouilj@ieee.org 2024-04-29T01:29:07-04:00 2024-04-29T01:29:07-04:00
changeset e3b34d02c61a
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description doc: add html versions of man pages

Also a minor change to prep for future inclusion of a generated
version of config.ini in reference document. This would replace the
incomplete description that is there.
files
docs: issue2551317 add support for jinja2 customization examples http://hg.code.sf.net:8000/p/roundup/code/#changeset-67438e439da838fd99fa341b0d61467fe303f642 John Rouillard rouilj@ieee.org 2024-02-17T18:56:04-05:00 2024-02-17T18:56:04-05:00
changeset 67438e439da8
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description docs: issue2551317 add support for jinja2 customization examples

Added sphinx-tabs to doc build. This allows adding code-tabs one for
"TAL" examples and one for "Jinja2" examples in the doc.

Converted partly the "Editing multiple items in an index view"
example. Sombody who knows jinja2 better than I, and can test the
example will need to finish it.

Documented requirement and method for building docs in developers.txt.
Added requirements.pip files for pip install -r ... modules needed for
processing docs.

Fixed missing block in layout.txt that stopped tabs.css from being
loaded.
files
Eliminate error w/ permalink setting for sphinx 5+; enable opesearch http://hg.code.sf.net:8000/p/roundup/code/#changeset-5bac0a0afb7f22e9b5fa3dc2e8b32bef906c12e9 John Rouillard rouilj@ieee.org 2023-06-20T00:53:39-04:00 2023-06-20T00:53:39-04:00
changeset 5bac0a0afb7f
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description Eliminate error w/ permalink setting for sphinx 5+; enable opesearch

opensearch enabled for website build only. Not local docs.
files
add file with sphinx requirements for building doc. http://hg.code.sf.net:8000/p/roundup/code/#changeset-452a8bd1d826226af82e7190866e7f41228b6ea9 John Rouillard rouilj@ieee.org 2023-06-15T20:46:59-04:00 2023-06-15T20:46:59-04:00
changeset 452a8bd1d826
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description add file with sphinx requirements for building doc.


Disable permalinks for older and newer sphinx versions.

make conf.py's work with old and new sphinx.

make layout.py work with 7.x sphinx which replaces the style
variable with styles[].
files
Autmatically get version and release from roundup/__init__.py http://hg.code.sf.net:8000/p/roundup/code/#changeset-f100f5fdf6bfa386e1369c99743c5dc0f9f9030b John Rouillard rouilj@ieee.org 2023-06-08T01:02:32-04:00 2023-06-08T01:02:32-04:00
changeset f100f5fdf6bf
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description Autmatically get version and release from roundup/__init__.py

Copy code from docs/conf.py that generates the release and version
settings from roundup/__init__.py into website/www/conf.py.

Update RELEASE.txt to remove need to set these manually and annotate a
couple of other documented changes.
files
re-enable security.html http://hg.code.sf.net:8000/p/roundup/code/#changeset-3ce81e49e8d474b7f43b43ed49ede6beafa8ba5f John Rouillard rouilj@ieee.org 2022-09-20T20:55:51-04:00 2022-09-20T20:55:51-04:00
changeset 3ce81e49e8d4
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description re-enable security.html

referenced from upgrading.txt in one of the 0.5.0 notes.
files
update copyright years. http://hg.code.sf.net:8000/p/roundup/code/#changeset-8179b07089946b27868418c34859c7a65865c132 John Rouillard rouilj@ieee.org 2021-04-26T23:39:30-04:00 2021-04-26T23:39:30-04:00
changeset 8179b0708994
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description update copyright years.
files
Doc updates for customizing.txt, start of index generation http://hg.code.sf.net:8000/p/roundup/code/#changeset-9619d64c03515838de3cc72e56f7b261ee9fcc70 John Rouillard rouilj@ieee.org 2020-05-11T00:02:31-04:00 2020-05-11T00:02:31-04:00
changeset 9619d64c0351
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description Doc updates for customizing.txt, start of index generation

customizing.txt:

fix doc on schema.py. Documented obsolete db schema
declaration/initial data method.

doc on config.ini is incomplete. doc as such. Add doc for [rdbms]:
backend, cache_size, sqlite_timeout

document Interval schema type. Also change formatting for list of
schema types to description list from regular list so types are more
visible.

add link to roundup wiki for schema chnge examples.

fix formatting for postfix config.

document Rest Access and Xmlrpc Access permissions; change classic
schema.py example to include them.

doc db/backend_name as obsolete, conf.py [rdbms] backend used
instead.

start adding index references

conf.py: update copyright year

index.txt: add link to genindex.html.

_templates/layout.html: change code to make index output work. Not
sure what the change does, just monkey pasting from
sphinx basic/layout.html
files
Changed references to http://issues.roundup-tracker.org to https now http://hg.code.sf.net:8000/p/roundup/code/#changeset-0df5f9eeefd452bc5be7ba03a7554ca95deb063d John Rouillard rouilj@ieee.org 2019-02-12T21:31:41-05:00 2019-02-12T21:31:41-05:00
changeset 0df5f9eeefd4
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description Changed references to http://issues.roundup-tracker.org to https now
that the site is TLS enabled.
files
issue2550907 Fix errors when creating documentation. Work done by http://hg.code.sf.net:8000/p/roundup/code/#changeset-487dc55e3c5e6072ebfe4dd82b90a2f7ee67eb58 John Rouillard rouilj@ieee.org 2016-06-10T21:28:40-04:00 2016-06-10T21:28:40-04:00
changeset 487dc55e3c5e
branch
bookmark
tag
user John Rouillard <rouilj@ieee.org>
description issue2550907 Fix errors when creating documentation. Work done by
Peter Funk (pefu).

Made one small change omitting obsolete security.txt.

Also fixed underlining in upgrading.txt so headers are properly
formatted.
files
Preparing 1.5.1 steps 7/16 http://hg.code.sf.net:8000/p/roundup/code/#changeset-515ab1749b142caff31113425d1322b0ad360195 anatoly techtonik techtonik@gmail.com 2016-01-11T21:59:17+03:00 2016-01-11T21:59:17+03:00
changeset 515ab1749b14
branch
bookmark
tag 1.5.1
user anatoly techtonik <techtonik@gmail.com>
description Preparing 1.5.1 steps 7/16

7. python setup.py build_doc

* fix include of basic.css for rendering permalink anchors
* make anchors less obtrusive
files
Preparing 1.5.1 steps 7/16 http://hg.code.sf.net:8000/p/roundup/code/#changeset-333b016217723215dc8000a0be6fdc24f219fb2f anatoly techtonik techtonik@gmail.com 2016-01-11T21:16:08+03:00 2016-01-11T21:16:08+03:00
changeset 333b01621772
branch
bookmark
tag
user anatoly techtonik <techtonik@gmail.com>
description Preparing 1.5.1 steps 7/16

7. python setup.py build_doc

* sync conf.py with Sphinx 1.3
files
Preparing 1.5.1 steps 7/16 http://hg.code.sf.net:8000/p/roundup/code/#changeset-46b7d1ee4fab31a92c0ed1c2046a7ef74ae6d3d1 anatoly techtonik techtonik@gmail.com 2016-01-11T20:48:44+03:00 2016-01-11T20:48:44+03:00
changeset 46b7d1ee4fab
branch
bookmark
tag
user anatoly techtonik <techtonik@gmail.com>
description Preparing 1.5.1 steps 7/16

7. python setup.py build_doc

* Fix WARNING: the config value 'html_add_permalinks' has type
`bool', defaults to `unicode.'
* Bump year to 2016
files
Synchronize conf.py between doc/ and website/www/ http://hg.code.sf.net:8000/p/roundup/code/#changeset-2d83625e1c06de51883fd42ff1481a6961146f21 anatoly techtonik techtonik@gmail.com 2014-12-13T19:17:10+03:00 2014-12-13T19:17:10+03:00
changeset 2d83625e1c06
branch
bookmark
tag
user anatoly techtonik <techtonik@gmail.com>
description Synchronize conf.py between doc/ and website/www/
files
Fix broken links to static html doc files (issue2550840) http://hg.code.sf.net:8000/p/roundup/code/#changeset-b26176334c88de8da944a9af32ff8a4273f32d7d John Kristensen john@jerrykan.com 2014-05-12T14:40:53+10:00 2014-05-12T14:40:53+10:00
changeset b26176334c88
branch
bookmark
tag
user John Kristensen <john@jerrykan.com>
description Fix broken links to static html doc files (issue2550840)

It seems as though these links have been broken every since sphinx has
been used to generate the documentation. Version 1.2 of sphinx
introduced the ability to include extra static files, so we are making
use of this facility to fix the links to static html files.
files
doc/conf.py: Clear sys.path before importing Roundup __version__ http://hg.code.sf.net:8000/p/roundup/code/#changeset-bf786562ba7f846401dc5e392db8072c4ab8a9b4 anatoly techtonik techtonik@gmail.com 2013-09-25T15:35:11+03:00 2013-09-25T15:35:11+03:00
changeset bf786562ba7f
branch
bookmark
tag
user anatoly techtonik <techtonik@gmail.com>
description doc/conf.py: Clear sys.path before importing Roundup __version__
This ensures that 'unkown version' is inserted when
`roundup` is importable from other location in sys.path
files
Read version and release for generated documentation from roundup/__init__.py http://hg.code.sf.net:8000/p/roundup/code/#changeset-76460d14be91e85ce6634aca8ffbde5f16013337 Thomas Arendsen Hein thomas@intevation.de 2013-09-19T16:23:42+02:00 2013-09-19T16:23:42+02:00
changeset 76460d14be91
branch
bookmark
tag
user Thomas Arendsen Hein <thomas@intevation.de>
description Read version and release for generated documentation from roundup/__init__.py

Release 1.5.0 contains documentation with version number 1.4, and the release
number never included the third part.
files
Beginnings of a big code cleanup / modernisation to make 2to3 happy http://hg.code.sf.net:8000/p/roundup/code/#changeset-13b3155869e050964ca244b2fc0e586e7918a3f3 Richard Jones richard@users.sourceforge.net 2010-02-22T05:26:57+00:00 2010-02-22T05:26:57+00:00
changeset 13b3155869e0
branch
bookmark
tag
user Richard Jones <richard@users.sourceforge.net>
description Beginnings of a big code cleanup / modernisation to make 2to3 happy
files
Enhance documentation generation. http://hg.code.sf.net:8000/p/roundup/code/#changeset-bca7c59ac40055e99cfff29f8e32db578ebaaea7 Stefan Seefeld stefan@seefeld.name 2009-02-12T05:54:26+00:00 2009-02-12T05:54:26+00:00
changeset bca7c59ac400
branch
bookmark
tag
user Stefan Seefeld <stefan@seefeld.name>
description Enhance documentation generation.
files