Opened 9 years ago

Last modified 8 years ago

#13 assigned enhancement

specdomain: create individual topics (pages) for macros when using .. autospecdir::

Reported by: cschlep Owned by: jemian
Priority: minor Milestone:
Keywords: specdomain Cc: cschlep

Description

Presently, all the macros inside a directory end up being documented on the same html page when using the .. autospecdir:: directive. It would be nice to create separate pages for each file.

Change History (5)

comment:1 Changed 9 years ago by jemian

(In [1065]) refs #13, show a bullet list at the top of the page (alternative to separate pages for each macro file)

comment:2 Changed 9 years ago by jemian

  • Status changed from new to assigned

Can't find an easy way to do this. For now, suggest using autospecmacro in separate files.

comment:3 Changed 9 years ago by jemian

Basic Sphinx question, not sure it can be done.

See https://groups.google.com/d/msg/sphinx-dev/-/qR1Bql3lfggJ

comment:4 Changed 8 years ago by cschlep

  • Type changed from defect to enhancement

comment:5 Changed 8 years ago by cschlep

One way to provide this is to use an external program to create .rst files, one for each .mac file to be documented. Each .rst file contains a single line referencing the associated .mac file.

There can be a problem when two or more .mac files, each in separate out-of-source directories have the same name. Could solve this by creating separate subdirectories within the .rst source tree that only contain references to files for that directory. Using a '00_index.rst' file to describe the directory path for this subdir should suffice. Something like that.

Note: See TracTickets for help on using tickets.