github/repmgr
1
0
Fork 0
mirror of https://github.com/EnterpriseDB/repmgr.git synced 2026-03-26 08:36:30 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

docs: add note about building docs

Browse Source
This commit is contained in:
Ian Barwick
2017-10-27 10:44:16 +09:00
parent 68756c79f3
commit a90d4419a6
1 changed files with 24 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/install-source.sgml
View File

@@ -30,8 +30,7 @@
building PostgreSQL with: building PostgreSQL with:
<programlisting> <programlisting>
sudo apt-get update sudo apt-get update
sudo apt-get build-dep postgresql-9.6 sudo apt-get build-dep postgresql-9.6</programlisting>
</programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@@ -44,8 +43,7 @@
sudo yum check-update sudo yum check-update
sudo yum groupinstall "Development Tools" sudo yum groupinstall "Development Tools"
sudo yum install yum-utils openjade docbook-dtds docbook-style-dsssl docbook-style-xsl sudo yum install yum-utils openjade docbook-dtds docbook-style-dsssl docbook-style-xsl
sudo yum-builddep postgresql96 sudo yum-builddep postgresql96</programlisting>
</programlisting>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@@ -88,8 +86,7 @@
<para> <para>
Clone the source code using <application>git</application>: Clone the source code using <application>git</application>:
<programlisting> <programlisting>
git clone https://github.com/2ndQuadrant/repmgr git clone https://github.com/2ndQuadrant/repmgr</programlisting>
</programlisting>
</para> </para>
<para> <para>
@@ -134,12 +131,31 @@
To installing &repmgr; from source, simply execute: To installing &repmgr; from source, simply execute:
<programlisting> <programlisting>
./configure && make install ./configure && make install</programlisting>
</programlisting>
Ensure <command>pg_config</command> for the target PostgreSQL version is in Ensure <command>pg_config</command> for the target PostgreSQL version is in
<varname>$PATH</varname>. <varname>$PATH</varname>.
</para> </para>
</sect2> </sect2>
<sect2 id="installation-build-repmgr-docs">
<title>Building &repmgr; documentation</title>
<para>
The &repmgr; documentation is (like the main PostgreSQL project)
written in DocBook format. To build it locally as HTML, you'll need to
install the required packages as described in the
<ulink url="https://www.postgresql.org/docs/9.6/static/docguide-toolsets.html">
PostgreSQL documentation</ulink> then execute:
<programlisting>
./configure && make install-doc</programlisting>
</para>
<para>
The generated HTML files will be placed in the <filename>doc/html</filename>
subdirectory of your source tree.
</para>
</sect2>
</sect1> </sect1>