Opened 8 years ago

Last modified 8 years ago

#57 new enhancement

topdoc: refactor to use Sphinx (ReST) for documentation

Reported by: jemian Owned by: jemian
Priority: major Milestone:
Keywords: Cc:

Description

This project is getting unwieldy using XML (& XSLT) as the way to document IOCs. Also, the interpretation of top-level IOCs has much of the BCDA design (including the use of synApps) built into it.

Refactor this project to use ReST

Change History (19)

comment:1 Changed 8 years ago by jemian

In 1478:

refs #57: prepare to tag existing work

comment:2 Changed 8 years ago by jemian

In 1479:

refs #57 (a conflict on the WD/src was accepted as working)

comment:3 Changed 8 years ago by jemian

In 1480:

refs #57

comment:4 Changed 8 years ago by jemian

In 1481:

refs #57: tag the current version before major refactoring

comment:5 Changed 8 years ago by jemian

In 1482:

refs #57: a new start

comment:6 Changed 8 years ago by jemian

In 1483:

refs #57: Sphinx configured and builds the HTML docs

comment:7 Changed 8 years ago by jemian

In 1484:

refs #57: add a little depth

comment:8 Changed 8 years ago by jemian

In 1486:

refs #57: digging deeper

comment:9 Changed 8 years ago by jemian

In 1487:

refs #57

comment:10 Changed 8 years ago by jemian

In 1488:

begin refactoring of topdoc, refs #57

comment:11 Changed 8 years ago by jemian

In 1491:

refs #57, improve the database parser, one more test case to improve (inline), database now described in restructured text

comment:12 Changed 8 years ago by jemian

In 1492:

refs #57; BIG improvement parsing EPICS databases, will replace database.py at next commit

comment:13 Changed 8 years ago by jemian

In 1493:

refs #57, database support refactored (2 TODO items for later consideration)

comment:14 Changed 8 years ago by jemian

In 1495:

prepare to parse dbLoadTemplate (substitution) files, refs #57, also LEARNJIRA-5

comment:15 Changed 8 years ago by jemian

In 1497:

refs #57, template parser works, reports need some work

comment:16 Changed 8 years ago by jemian

In 1498:

macro expansion in template file name, refs #57

comment:17 Changed 8 years ago by jemian

In 1499:

refs #57, start to re-write the command file parser

comment:18 Changed 8 years ago by jemian

In 1500:

refactor to use enclosed list parser, refs #57

comment:19 Changed 8 years ago by jemian

In 1505:

refs #57, separate rest_table source from this project, now available for install via:

pip install pyRestTable

or

easy_install -U pyRestTable

Note: See TracTickets for help on using tickets.