Opened 8 years ago

Last modified 4 years ago

#782 assigned enhancement

Need to be able to generate documention for bundles

Reported by: Greg Couch Owned by: Greg Couch
Priority: major Milestone:
Component: Documentation Version:
Keywords: Cc: Zach Pearson
Blocked By: Blocking:
Notify when closed: Platform: all
Project: ChimeraX

Description (last modified by Greg Couch)

Bundles are built using the ChimeraX application. Thus sphinx et. al. needs to move from the build tree to the app tree so bundles can build developer documentation too.

Change History (17)

comment:1 by Greg Couch, 8 years ago

Blocking: → 783

comment:2 by Eric Pettersen, 8 years ago

Component: Unassigned → Documentation
Owner: set to Greg Couch
Status: new → assigned

comment:3 by Eric Pettersen, 8 years ago

Milestone: Beta Release → 0.5

Milestone renamed

comment:4 by Conrad Huang, 8 years ago

Milestone: 0.5 → 0.6

comment:5 by Greg Couch, 8 years ago

Milestone: 0.6 → 0.7

comment:6 by Greg Couch, 8 years ago

Blocking: 783

comment:7 by Greg Couch, 8 years ago

Cc: Conrad Huang added
Description: modified (diff)
Milestone: 0.7 → 0.9

comment:8 by Greg Couch, 7 years ago

Priority: blocker → major

comment:9 by Conrad Huang, 7 years ago

Milestone: 0.9 → 1.0

comment:10 by Scooter Morris, 6 years ago

Milestone: 1.0 → 1.1

comment:11 by Scooter Morris, 5 years ago

Milestone: 1.1 → 1.2

comment:12 by Greg Couch, 5 years ago

Type: defect → enhancement

comment:13 by Greg Couch, 5 years ago

Milestone: 1.2 → 1.3

comment:14 by Zach Pearson, 4 years ago

Cc: Zach Pearson added

comment:15 by Greg Couch, 4 years ago

Description: modified (diff)

Moving sphinx to app requirements and changing the build system to use sphinx out of the app tree is the first step.

Then, we need to add a way to for the devel command to generate documentation as well so it is included in the bundle. The user documentation is expected to be placed in the bundle source in src/docs/user/commands/CMD.html and src/docs/user/tools/TOOL.html. And <DataDir>docs</DataDir> placed in the bundle_info.xml file. Those command and tools will be automatically added to the user documentation index. Developer API information could be placed in the src/docs/devel/SOMEWHERE, but there is no automatic integration with the rest of the developer documentation, so there is no advantage of putting it there yet.

comment:16 by Greg Couch, 4 years ago

Milestone: 1.3 → 1.4

Completely removed Sphinx from build tree, so it is only in app tree.

comment:17 by Greg Couch, 4 years ago

Cc: Conrad Huang removed
Milestone: 1.4
Note: See TracTickets for help on using tickets.