Menu

SVN archive Commit Log


Commit Date  
[r16606] by bugman

Complete rewrite of the docs.latex.fetch_docstrings module (accidentally partly committed at r16596).

This is a significant simplification for the creating of the user function documentation within the
user manual. Some of the long list of changes include:

- The file docs/latex/fetch_docstrings.py is no longer an executable script and now operates solely
as a Python module.

- All of the original docstring section parsing code has been eliminated. The searching for user
functions in the prompt UI namespace has been replaced

- The new user function definitions are directly used and the documentation for each user function
section generated via the self.build_*() methods.

- The complicated ascii table parsing and rebuilding into a LaTeX table has been eliminated.

- The self.write_*() methods have been created for building the various sections of the user
function documentation (paragraphs, verbatim text, prompt examples, lists, itemised lists, and
tables).

- Tables are no longer duplicated, triplicated, etc. Instead a reference to the first instance of
the table is inserted. This is a significant space saver, as one of the copies of the multi-page
X11 colour table is removed.

2012-06-03 10:40:27 Tree
[r16605] by bugman

Renamed the Uf_tables.add_table() 'title' arg to 'caption', and added the new 'caption_short' arg.

The name change is fairly logical, as this is a caption. The 'caption_short' arg will be used for
the list of tables in the LaTeX user manual.

2012-06-03 10:17:13 Tree
[r16604] by bugman

The Molmol colour table is no longer a longtable.

2012-06-02 18:24:23 Tree
[r16603] by bugman

The prompt UI table creation is now using the Table.spacing variable for adding empty lines between rows.

2012-06-02 17:43:59 Tree
[r16602] by bugman

Fixes for the prompt UI construction of the tables.

The top line was sometimes one '_' character too long. Now the correct table width is calculated as
it may not always match status.text_width.

2012-06-02 17:41:10 Tree
[r16601] by bugman

The Monte Carlo description now uses an itemised list for the listing of the steps involved.

2012-06-02 17:30:35 Tree
[r16600] by bugman

The prompt UI help string construction code is now handling the new Uf_tables singleton.

2012-06-02 17:26:07 Tree
[r16599] by bugman

Added a check to Uf_tables.get_table() to make sure that the table corresponding to the label exists.

2012-06-02 17:24:15 Tree
[r16598] by bugman

Fixes to the calls to Desc_container.add_table() in some user functions.

2012-06-02 17:23:02 Tree
[r16597] by bugman

Added a check to Desc_container.add_table() to make sure the label is a string!

2012-06-02 17:22:33 Tree
Older >
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.