[Docutils-users] How to add index information

[Alan W. <ala...@li...>]

Hello,

I am downloading reStructuredText from our website. These files are used along with Sphinx to create the sites on-line (ReadTheDocs) documentation.

I want to ‘tag’ words within the downloaded reST files ahead of converting these to XHTML which is used to build the index at the end of a generated PDF document. The tagged rest documents are loaded back to the sites repository so that the tagging is persisted. So I am looking for a way of adding tags that will be ignored by the sites processes.  I need to tag specific words inline so ‘.. Comments’ will not work, but perhaps there is another way?

My simple naïve approach was to embed html comments ahead of the word(s), for example putting <!—startTag --> before the words and <!—endTag --> after them.  This worked for my processes but the web-site documentation processes don’t keep these as comments and they appear on the screen.

Any suggestions would be appreciated.