Opened 10 years ago

Closed 10 years ago

#8 closed enhancement (fixed)

create sphinx plugin to document spec macro source code files

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

Description


Change History (46)

comment:1 Changed 10 years ago by jemian

  • Owner set to jemian
  • Status changed from new to assigned
  • Type changed from defect to enhancement

comment:2 Changed 10 years ago by jemian

(In [909]) refs #8

comment:3 Changed 10 years ago by jemian

(In [910]) refs #8

comment:4 Changed 10 years ago by jemian

(In [912]) refs #8

comment:5 Changed 10 years ago by jemian

(In [913]) refs #8

comment:6 Changed 10 years ago by jemian

(In [919]) refs #8, rest for the night

comment:7 Changed 10 years ago by jemian

(In [927]) refs #8, directives work, no SPEC entries in the index, re-examine the standard domains supplied with Sphinx to improve

comment:8 Changed 10 years ago by jemian

(In [929]) restart with simpler domain, start to add index entries, refs #8

comment:9 Changed 10 years ago by jemian

(In [930]) refs #8, progress on adding directives to the index

comment:10 Changed 10 years ago by jemian

(In [935]) refs #8, now handles cdef (still needs to parse additional arguments properly), Index entries are much improved, now gathers definitions together in index

comment:11 Changed 10 years ago by jemian

(In [936]) refs #8, directives and roles are working at some level, ready to learn how to document SPEC macro source files

comment:12 Changed 10 years ago by jemian

(In [937]) refs #8, document the commands, as they exist now

comment:13 Changed 10 years ago by jemian

(In [940]) refs #8, making progress, discard code from previous attempt

comment:14 Changed 10 years ago by jemian

(In [941]) working on the SPEC parser (to also grab file line numbers), still can't get extended comments into regular rst document body, going into the signature node instead, refs #8

comment:15 Changed 10 years ago by jemian

(In [942]) refs #8, apply ANL's short-form license, starting to understand how to get content added, try additional test case SPEC macro file

comment:16 Changed 10 years ago by jemian

(In [956]) refs #8, basics of the parser are established

comment:17 Changed 10 years ago by jemian

(In [957]) refs #8, now parses global, local, and constant declarations, need to parse macro definitions next

comment:18 Changed 10 years ago by jemian

(In [961]) refs #8

comment:19 Changed 10 years ago by jemian

(In [963]) refs #8, big progress today, now able to get ReST-formatted extended comments from SPEC .mac files into Sphinx output using autodoc and subclassing the autodoc.Documenter class for SPEC.

Also, breaking up the test document into parts to make it easier to follow.

comment:20 Changed 10 years ago by jemian

(In [964]) refs #8, clean up the imports, provide .mac source link from autodocumenter

comment:21 Changed 10 years ago by jemian

(In [965]) refs #8, section titles in extended comments now handled properly

comment:22 Changed 10 years ago by jemian

(In [966]) refs #8, commas allowed in variable declarations as delimiter, reduce code smell in parser state engine, aggregate test macro suite

comment:23 Changed 10 years ago by jemian

(In [967]) refs #8, discard development version

comment:24 Changed 10 years ago by jemian

(In [968]) refs #8, discard development version

comment:25 Changed 10 years ago by jemian

(In [973]) refs #8, unify the version information

comment:26 Changed 10 years ago by jemian

(In [979]) refs #8, tester4.py defines matches for macro declarations in source files

comment:27 Changed 10 years ago by jemian

(In [983]) refs #8, now parses most macro definitions (just the initial declaration, not the muiltiline content, for now)

comment:28 Changed 10 years ago by jemian

(In [987]) refs #8, add .mac files to the index

comment:29 Changed 10 years ago by jemian

(In [988]) refs #8, add variables to the index in two ways, add mac declarations to index in two ways

comment:30 Changed 10 years ago by jemian

(In [989]) refs #8, still need to understand how the index is configured in the domain

comment:31 Changed 10 years ago by jemian

(In [990]) refs #8, refactor the table maker

comment:32 Changed 10 years ago by jemian

(In [993]) refs #8, find function macros first, improve function macro detection

comment:33 Changed 10 years ago by jemian

(In [994]) refs #8, add autospecdir, no options supported yet

comment:34 Changed 10 years ago by jemian

(In [995]) refs #8, bring this up to date

comment:35 Changed 10 years ago by jemian

(In [1002]) refs #8, now handle multi-line cdef

comment:36 Changed 10 years ago by jemian

(In [1004]) refs #8, now shows docstrings, need to improve the directive and role handling now, especially with regard to the signature

comment:37 Changed 10 years ago by jemian

(In [1007]) refs #8, much, MUCH better reporting, almost ready for release, need to improve the "howto" documentation in the docs/ subdir

comment:38 Changed 10 years ago by jemian

(In [1009]) refs #8, note taking, search stopped working with [998]

comment:39 Changed 10 years ago by jemian

(In [1010]) refs #8, WWW search is repaired: VERSION file gained a linefeed that caused problems

comment:40 Changed 10 years ago by jemian

(In [1012]) refs #8, also index macro declarations under parent macro file, handle one pathological case in index

comment:41 Changed 10 years ago by jemian

(In [1013]) refs #8, add to the HOWTO part

comment:42 Changed 10 years ago by jemian

(In [1020]) refs #8, show how to markup a SPEC Macro File

comment:43 Changed 10 years ago by jemian

(In [1027]) refs #8, finished documenting a complete example

comment:44 Changed 10 years ago by jemian

(In [1028]) refs #8: finish the documentation

comment:45 Changed 10 years ago by jemian

(In [1029]) refs #8: prepare for first release

comment:46 Changed 10 years ago by jemian

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [1030]) fixes #8: release v1.0

Note: See TracTickets for help on using tickets.