| changeset | 6cf700cae7f6 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | build: linkcheck tripping rate limits. Tell linkcheck to respect rate limits by delaying by a server specified delay. |
| files |
| changeset | 78b13272d41b |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | docs: link to Client and TemplatingUtils class/method docstrings pydoc.txt: new page. Has two example autodoc invocations: automethod and autoclass. docs.txt Added pydoc.txt as a hidden page in a new toc in docs.txt. Added includehidden in toc directive.Not sure what it does, but was part of a recipie to hide the pydoc from the main TOC. conf.py: added sphinx.ext.autodoc to get it pulling in the docs. reference.txt: added references to the pydoc using :py:meth: for templating utils methods like set-http_response and :py:class: for Client as the existing docs referenced the docstrings. Changed table formatting for the TemplatingUtils methods from table to list-table. The length of the references to the methods was too large to exist in the first column of a drawn table. For right now the pydoc stuff is only referenced via links from the main docs. Currently it is ugly, but the additional info on tempating utils and their arguments can be helpful. Added sphin |
| files |
| changeset | c80de1b0dd83 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | chore: it's 2025, update copyrights |
| files |
| changeset | e1c477c5d63f |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | docs: fix formattin issue caused by removal of html_style key. With empty value, it inserts default sphinx css. |
| files |
| changeset | 57ef20b6c003 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | docs: fix some missing/broken links. |
| files |
| changeset | d6b447de4f59 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | docs: set up for release documentation. Make changes to publish security.html with CVE announcements referring to the sections in upgrading.html rather than CVE.html. Remove templates.zip as part of html build in Makefile. Also update doc for using CVE.html. |
| files |
| changeset | 6d4b5005abf2 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | docs: changes to website docs to announce CVE's Changes to the website doc generation to create CVE.html by extracing secions from upgrading.txt. It also allows overriding the release version that is displayed in the web page titles. It also adds support for making a zipfile (which is better supported on windows that a tarball) of the templates needed to address the CVE in the tracker home html files The next commit for this directory will remove the generation of the CVE.html file as CVE remediation/scope issue will be in the upgrading.html document. It will also remove generation of templates.zip. |
| files |
| changeset | b516483f68a3 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | docs: add opengraph tags to website. |
| files |
| changeset | a377590eba34 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | changes for 2.4.0b0 release |
| files |
| changeset | 828f79ae965b |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | doc: update links and docs on checking links Add timeout for link checking so make linkcheck completes. Document grep command to use to filter broken links to external links. Fix PostgreSQL links to point to current pages. Fix pyreadline3 link. Fix vim po file plugin link Use wayback machine for zpi internationalization link. |
| files |
| 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 |
| changeset | 4376d8c19b2a |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | docs: remove COPYING.html from website/www tree. The file should not be published. It gets published as license.html and linked as such from the side menu. |
| files |
| 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 |
| changeset | 06a2f79389b6 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Set language to en explicitly. Suppress warning on newer sphinx. |
| files |
| 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 |
| 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 |
| changeset | 51fc06fabcee |
|---|---|
| branch | |
| bookmark | |
| tag | 2.3.0b2 |
| user | John Rouillard <rouilj@ieee.org> |
| description | Changes for roundup release 2.3.0b2 I missed changing announcements.txt so the b1 release has the 2.2.0 release announcment when I uploaded to test.pipi.org. |
| files |
| changeset | 623502678b97 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | 2.3.0b1 release changes roundup/__init__.py: Update version setup.py: Mark as beta release; add python 3.11/3.12 as supported language versions. website/www/conf.py: update version/release to 2.3b1/2.3.0b1 website/www/index.txt: update highlights/version website/www/signatures/: Add 2.3.0b1 pgp signature. Will be removed when 2.3.0 is released but this allows me to test. docs: Fix links Update acknowlegements with 2.3.x churn/contrib etc. locale: update software version, creation date; rebuild template and propagate changes. MANIFEST.in: add locale/Makefile |
| files |
| changeset | a210f4437b49 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Incomplete work to generate config doc from config.ini This is an incomplete attempt to allow generation of the config.ini documentation in reference.txt. It reformats the output of 'roundup_admin.py genconfig'. So it now includes all of the settings. Using a Makefile rule like: tracker_config.txt: ../roundup/configuration.py python3 ../roundup/scripts/roundup_admin.py \ genconfig _temp_config.txt sed -e '1,8d' \ -e 's/^\[\([a-z]*\)\]/\n.. index:: config.ini; sections \1\n\n.. code:: ini\n\n [\1]/' \ -e 's/^\([^[]\)/ \1/' \ _temp_config.txt > tracker_config.txt rm -f _temp_config.txt results in the config.ini split by section and index links being put in place. However some sections have a comment before the [section] marker. This comment is orphaned at the end of the prior section rather than starting the new section. A simple sed won't allow the lookahead needed to target the [section] marker and include the prior comment block. Also there are still have some long lines generated (> 65 characters). Maybe a python script can import configuration.py and output proper restructured text output? reference.txt: add a commented out include:: tracker_config.txt directive roundup/admin.py: don't require a tracker home for genconfig. So user can generate a clean config.ini on demand. Tracker home is still required for updateconfig. roundup/configuration.py: wrap lines better. A number of them are generating comments > 65 characters which is the targeted line length. This cleans up config.ini too, so is a good thing. website/www/conf.py: ignore doc/tracker_config.ini when processing. |
| files |
| changeset | 42a2ae439705 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | update copyright end date. |
| files |
| changeset | 7109cdf8fef4 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Do not hyperlink some exampe url's. The example url's should not be hyperlinked. They show up as dead links in ahrefs etc. Make linkcheck report them if they show up again. |
| files |
| changeset | 1836e0ef7751 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Add new security.txt Add to index, remove security.txt from exclude list in website. Add :orphan: to security-history.txt since it is only linked from upgrading.txt. |
| files |
| changeset | a93ef7aec24e |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | disable opensearch generation. It doesn't work. It references an opensearch.html page in the generated docs which doesn't exist. The opensearch.xml file is (properly??) generated in _static, but referenced in the sitemap at the root not in _static. |
| files |
| changeset | 502fb803fc22 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | fix version. |
| files |
| changeset | 8291903b825a |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | fix icon path. |
| files |
| changeset | d669f96dc580 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | www: add favicon, opensearch favicon.ico from doc/roundup-favicon.ico |
| files |
| changeset | 339805c4a85b |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Pygments has poor code block contrast outout using sphinx style. Change to borland theme. This eliminated 68 poor contrast (< AA) examples on upgrading.html. Even more on other pages. axe DevTools is now happier. Borland theme/style doesn't color the bacground of the code blocks, so set to lightyellow in style.css. This still allows good contrast. |
| files |
| changeset | d93b441ee778 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Handle build issues, update css for mobile I added www.roundup-tracker.org as a property of mine in google search console. It reports bad mobile experience. According to the goatcounter tracker I put in, we get 400 hits from phones/small tablets; 400 from tablets/small laptops and 800 from computer screens. So 1/4 is mobile and 1/2 is not a large computer screen. On mobile (<960px) the left hand menu is stacked on top of the column in mobile sizes. Sub-menu links are spaced apart to make them easier to clkick on with a finger. Same with the table of contents in the documents. The main document content is now full display width (rather than scrunched to the right side of the display). This is just a quick hack, but it should make the docs more usable. As I worked, I found that _static/style.css changes were not being copied into the html build directory when sphinx was rerun. Nuke entire html subdir and rebuild from scratch each time. Also added comments to Makefile. Also robots.txt was being added as extra_html by sphinx, but it causes a missing from TOC error that exits the build (when using -W). Since exiting on warning is better, I changed Makefile to add robots.txt. Removed robots.txt references from conf.py. |
| files |
| changeset | b3ba03d2b214 |
|---|---|
| branch | |
| bookmark | |
| tag | 2.2.0b1 |
| user | John Rouillard <rouilj@ieee.org> |
| description | 2.2.0b1 release changes |
| files |
| changeset | 5855a6a26bdd |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Add sitemap to docs. Also add robots.txt to advertize sitemap. |
| files |
| changeset | 54af7ce65e6e |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Add canonical url link in header Add canonical url to all pages. Requires upgrade to at least 1.8.0 of sphinx. Upgraded virualenv on sourceforge to have sphinx 1.8.5 to allow it to work. Hand patched the files on sourceforge and deployed. Also added a postprocess step to Makefile needed on sourceforge to load searchtools.js. |
| files |
| changeset | cbc18a8bc61f |
|---|---|
| branch | |
| bookmark | |
| tag | 2.1.0 |
| user | John Rouillard <rouilj@ieee.org> |
| description | Changes for release of version 2.1.0. Updates specified in RELEASE.txt. |
| files |
| changeset | 5296d27ac97c |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Implementing RELEASE.txt 2.1.0b1 release Also spellcheck CHANGES.txt. |
| files |
| changeset | 45e8d10a9609 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Update links in documentation Only broken link is for whoosh indexer. Have email to author to find out if it's dead or what URL I shoud use. |
| files |
| changeset | 3a851df879cd |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Remove doc dependency sphinxcontrib-cheeseshop. Was used for download button in the index page for the website. It is still pointing to the old http pypi endpoint. I tried to override cheeseshop_url in the sphinx conf.py without luck. Richard Jones forgot that cheeseshop existed, so I think it can be considered depricated. Removed cheeseshop directive and inserted http markup using raw directive to provide download "button" to link to latest package page on https://pypi.org. |
| files |
| changeset | 043a8ffd79ad |
|---|---|
| branch | |
| bookmark | |
| tag | 2.0.0 |
| user | John Rouillard <rouilj@ieee.org> |
| description | Commits for roundup 2.0 release. |
| files |
| changeset | c2fd254c9257 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Doc updates/indexing. doc/admin_guide.txt, doc/customizing.txt, doc/features.txt, doc/installation.txt, doc/mysql.txt, doc/postgresql.txt: adding index entries doc/customizing.txt: reference schema changes later in document in addition to wiki. website/www/contents.txt: make wiki url https:.... Remove indices/tables as they don't show up in web interface. Put docs/announcement.txt into hidden toctree to silence warning from sphinx. Announcement.txt is referenced from index.txt so can't silence by adding to conf.py exclude_patern. website/www/index.txt: mention security and other improvements in jinja2 templates. website/www/conf.py: get rid of all warning by using exclude_patterns to ignore docs that aren't included. Remove exclude_trees using exclude_pattern instead. Make html_add_permalinks value acceptable so no warning reported. website/www/_static/style.css, website/www/_templtes/layout.html: add prev/next/index links for all doc pages. |
| files |
| changeset | d0c11eb2b9c2 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | fix release version |
| files |
| changeset | eb9d00db0923 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Forgot to check in changed doc files for 2.0.0beta0 |
| files |
| changeset | 29d428927362 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | prep for 2.0.0alpha0 release. Initial set of changes for the release. Still a few files to change. |
| files |
| changeset | b68d3d8531d5 |
|---|---|
| branch | maint-1.6 |
| bookmark | |
| tag | 1.6.1 |
| user | John Rouillard <rouilj@ieee.org> |
| description | Changes to prepare for 1.6.1 release. |
| files |
| changeset | e6bee80c20f8 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | Ignore localhost links and ignore www.zope.org links as they are in the license document. |
| files |
| changeset | cb4b232fcbaa |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | Bernhard Reiter <bernhard@intevation.de> |
| description | website: bump copyright to 2019 |
| files |
| changeset | 9e2f5a615eca |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Rouillard <rouilj@ieee.org> |
| description | website/www/conf.py needs copyright update and version update. added requirement to RELEASE.txt. |
| files |
| changeset | 2d83625e1c06 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | anatoly techtonik <techtonik@gmail.com> |
| description | Synchronize conf.py between doc/ and website/www/ |
| files |
| changeset | d28a648678e7 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | John Kristensen <john@jerrykan.com> |
| description | Update website to display 1.5 as the release version The roundup website is still displaying the current stable version as 1.4.x though 1.5.x has been out for a while now. |
| files |
| changeset | 276bcbd1f4e4 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | Bernhard Reiter <bernhard@intevation.de> |
| description | Website: Its 2013 now. |
| files |
| changeset | 433ddb5466e9 |
|---|---|
| branch | |
| bookmark | |
| tag | |
| user | Bernhard Reiter <bernhard@intevation.de> |
| description | Fixing the download button re-activating the cheeseshop plugin in the sphinx config. Thanks to Richard for the hint. |
| files |
| changeset | e4950073153f |
|---|---|
| branch | website |
| bookmark | |
| tag | |
| user | Stefan Seefeld <stefan@users.sourceforge.net> |
| description | Adjust to better sync with roundup docs. |
| files |
| changeset | d62831da3941 |
|---|---|
| branch | website |
| bookmark | |
| tag | |
| user | Stefan Seefeld <stefan@users.sourceforge.net> |
| description | svn repository setup |
| files |