Mercurial > p > roundup > code
view roundup/__init__.py @ 7371:a210f4437b49
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.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 17 May 2023 13:34:36 -0400 |
| parents | a1868fe784d0 |
| children | 623502678b97 |
line wrap: on
line source
# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # This module is free software, and you may redistribute it and/or modify # under the same terms as Python, so long as this copyright message and # disclaimer are retained in their original form. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # '''Roundup - issue tracking for knowledge workers. This is a simple-to-use and -install issue-tracking system with command-line, web and e-mail interfaces. Roundup manages a number of issues (with properties such as "description", "priority", and so on) and provides the ability to (a) submit new issues, (b) find and edit existing issues, and (c) discuss issues with other participants. The system will facilitate communication among the participants by managing discussions and notifying interested parties when issues are edited. Roundup's structure is that of a cake:: _________________________________________________________________________ | E-mail Client | Web Browser | Detector Scripts | Shell | |------------------+-----------------+----------------------+-------------| | E-mail User | Web User | Detector | Command | |-------------------------------------------------------------------------| | Roundup Database Layer | |-------------------------------------------------------------------------| | Hyperdatabase Layer | |-------------------------------------------------------------------------| | Storage Layer | ------------------------------------------------------------------------- 1. The first layer represents the users (chocolate). 2. The second layer is the Roundup interface to the users (vanilla). 3. The third and fourth layers are the internal Roundup database storage mechanisms (strawberry). 4. The final, lowest layer is the underlying database storage (rum). These are implemented in the code in the following manner:: E-mail User: roundup-mailgw and roundup.mailgw Web User: cgi-bin/roundup.cgi or roundup-server over roundup.cgi.client and roundup.cgi.template Detector: roundup.roundupdb and templates/<template>/detectors Command: roundup-admin Roundup DB: roundup.roundupdb Hyper DB: roundup.hyperdb, roundup.date Storage: roundup.backends.* Additionally, there is a directory of unit tests in "test". For more information, see the original overview and specification documents written by Ka-Ping Yee in the "doc" directory. If nothing else, it has a much prettier cake :) ''' __docformat__ = 'restructuredtext' __version__ = '2.2.0' # vim: set filetype=python ts=4 sw=4 et si
