actions on the site as a whole

Site Index

You can make an index over the entire document collection:

/docs/rst2html/site/create-index.png

For that you have to define references in the source texts using the refkey directive:

/docs/rst2html/site/index-refs.png

These can then be used to create the index document, like:

/docs/rst2html/site/index-page.png

Generate in bulk

You can (re)generate all the site documents and copy them to the mirror site all in one go:

/docs/rst2html/site/regenerate.png

You can choose to do all, all that is needed (just the ones with recent changes), and all that is new since the last time; besides that you can select to preview what will be done or to actually do it. For that you select ine of the options before executing the function:

/docs/rst2html/site/regenerate-options.png

The result of a preview action could look like this:

/docs/rst2html/site/regenerate-output-simulation.png

And the result of the real thing like this:

/docs/rst2html/site/regenerate-output.png

Find / replace

You can perform a find/replace action on all site documents

/docs/rst2html/site/search.png

First you have to specify what you want to do:

/docs/rst2html/site/search-start.png

The output of a search action could look like this:

/docs/rst2html/site/search-output.png

Replace is only executed if there's actually something in the replace field. This way you can for instance first find out which documents - if any - contain a search phrase, and then replace it everywhere (eventually extending the phrase to refine the search).

Directives check

You can perform an action to see if the directives that are used in the site documents correspond to the stylesheets that are used on the site, in other words if all the directives can be realized using the css.

/docs/rst2html/site/check-site.png

The output of a check-action could look like this:

/docs/rst2html/site/check-output.png

This message shows which css classes need to be added to one of the site's stylesheets to make all the directives work. You can of course also add the missing classes in a new separate stylesheet.

Progress overview

You can make a report of which pages are in which state of development

/docs/rst2html/site/progress-overview.png

This function inspects the update information of all rst source texts, the corresponding HTML documents and the copies in the mirror directory and compares them. The resulting report has the most recent dates shown accented.

This produces output that could look like this:

/docs/rst2html/site/overview-output.png