mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2024-12-14 10:13:05 +02:00
eaa981c5aa
Added an execution cache so that documentation can be generated without setting up the full container environment. This is useful for packaging, keeps the documentation consistent for a release, and speeds up generation when no changes are made in the execution list.
66 lines
2.8 KiB
XML
66 lines
2.8 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE doc SYSTEM "manifest.dtd">
|
|
<doc>
|
|
<!-- System-wide variables -->
|
|
<variable-list>
|
|
<variable key="project">pgBackRest</variable>
|
|
<variable key="version" eval="y">use pgBackRest::Version; $VERSION</variable>
|
|
<variable key="version-stable" eval="y">
|
|
use BackRestDoc::Custom::DocCustomRelease;
|
|
|
|
(new BackRestDoc::Custom::DocCustomRelease(
|
|
new BackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->currentStableVersion();
|
|
</variable>
|
|
<variable key="project-exe">pgbackrest</variable>
|
|
<variable key="project-url-root">/</variable>
|
|
<variable key="postgres">PostgreSQL</variable>
|
|
<variable key="dash">-</variable>
|
|
<variable key="project-logo">logo.png</variable>
|
|
<variable key="project-favicon">favicon.png</variable>
|
|
|
|
<!-- Logo locations -->
|
|
<variable key="logo">{[doc-path]}/output/latex/logo</variable>
|
|
|
|
<!-- HTML variables -->
|
|
<variable key="html-footer" eval='y'>
|
|
use POSIX qw(strftime); 'Copyright &copy; 2015' . '-' . strftime('%Y', localtime) .
|
|
', The PostgreSQL Global Development Group, <a href="{[github-url-license]}">MIT License</a>. Updated ' .
|
|
strftime('%B ', localtime) . trim(strftime('%e,', localtime)) . strftime(' %Y.', localtime)</variable>
|
|
<!-- <variable key="html-logo"><img src="{[project-logo]}"></variable> -->
|
|
|
|
<!-- PDF variables -->
|
|
<variable key="pdf-title">{[project]} User Guide</variable>
|
|
<variable key="pdf-subtitle">Open Source PostgreSQL Backup and Restore Utility</variable>
|
|
<variable key="pdf-file">CrunchyBackRest-UserGuide-{[version]}</variable>
|
|
</variable-list>
|
|
|
|
<source-list>
|
|
<source key="index"/>
|
|
<source key="user-guide"/>
|
|
<source key="reference" type="custom"/>
|
|
<source key="release" type="custom"/>
|
|
<source key="backlog"/>
|
|
<source key="test"/>
|
|
</source-list>
|
|
|
|
<render-list>
|
|
<render type="html">
|
|
<render-source key="index" menu="Home"/>
|
|
<render-source key="user-guide" menu="User Guide"/>
|
|
<render-source key="configuration" source="reference" menu="Configuration"/>
|
|
<render-source key="command" source="reference" menu="Commands"/>
|
|
<render-source key="release" menu="Releases"/>
|
|
<render-source key="backlog" menu="Backlog"/>
|
|
</render>
|
|
|
|
<render type="pdf" file="{[pdf-file]}">
|
|
<render-source key="user-guide"/>
|
|
</render>
|
|
|
|
<render type="markdown">
|
|
<render-source key="index" file="../../../README.md"/>
|
|
<render-source key="test" file="../../../test/README.md"/>
|
|
</render>
|
|
</render-list>
|
|
</doc>
|