Hello all -- I figured out part of this myself -- solutions below in case anyone else runs into this.
On Sunday, March 11, 2012 2:38:20 PM UTC-7, Ramon wrote: > > Hi all -- > > Are there any rst / sphinx directives that can be used to flag content > based on editorial workflow (DRAFT, NEEDSREVIEW, or FIXME) and that > could be highlighted in the generated docs, listed in an index and > programmatically excluded based on a build configuration? > > For example, I'd like to do is mark specific sections based on their > draft status and whether someone needs to take a look at it, and then > build stuff into the docs that help people quickly focus on those > areas: > > 1. Content is flagged using that tag to be formatted distinctly in the > generated documentation (e.g. a "NEEDS REVIEW" text prefixed to > paragraphs marked as such). > You can sort of this this with the todo extension, which ships with Sphinx: http://sphinx.pocoo.org/extensions.html#builtin-sphinx-extensions It lets you mark sections as "todo" and highlights them, as with a term reference. No styling options, but gets the job done. > 2. Flagged sections are listed in a distinct index (e.g. "List of > paragraphs marked NEEDSREVIEW") > Can be done with the todolist directive, part of the above extension. 3. Optionally strip out any content marked this way from a build (i.e. > remove all NEEDSREVIEW sections from a given build). > > Can be done with the todo_include_todoes configuration flag. > It looks like the Admnonition directive can get me the #1, but I'm not > sure about #2 or #3. Any suggestions? > > Thanks, > > Ramon > -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/atxs_IOP-vcJ. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
