gnucash-docs stable: Update git branches for API docs
Frank H.Ellenberger
fell at code.gnucash.org
Sun Aug 20 19:37:57 EDT 2023
Updated via https://github.com/Gnucash/gnucash-docs/commit/77a6ff72 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/35ac3909 (commit)
commit 77a6ff72ac7d7ba765e61044ab6ec879b4fe71ba
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Sun Aug 20 19:29:57 2023 +0200
Update git branches for API docs
diff --git a/C/guide/ch_python_bindings.xml b/C/guide/ch_python_bindings.xml
index 206e4e64..983d934b 100644
--- a/C/guide/ch_python_bindings.xml
+++ b/C/guide/ch_python_bindings.xml
@@ -51,7 +51,7 @@ Translators:
<tip>
<para>This chapter is not about how to write your own &app-py; scripts. Refer to the
- <ulink url="&url-doc-api-main;python_bindings_page.html">developer documentation</ulink> for
+ <ulink url="&url-doc-api-stable;python_bindings_page.html">developer documentation</ulink> for
that instead.
</para>
</tip>
diff --git a/C/manual/ch_Reports.xml b/C/manual/ch_Reports.xml
index 50af283b..64a06ae8 100644
--- a/C/manual/ch_Reports.xml
+++ b/C/manual/ch_Reports.xml
@@ -4136,9 +4136,13 @@ Income (type INCOME)
<para>Because the above file only contains the syntax of the function you can use the nightly
<application>Doxygen</application> generated <acronym>API</acronym> documentation online for
- the <ulink url="&url-doc-api-main;">bugfix branch</ulink> or
- <ulink url="&url-doc-api-mast;">feature branch</ulink> to get more information about the
- functions.
+ the <ulink url="&url-doc-api-stable;">stable branch</ulink>
+ <footnote id='branch-future'>
+ <para>After the first feature of the next <emphasis>major</emphasis> release got implemented a
+ <ulink url="&url-doc-api-future;">future branch</ulink> will also appear.
+ </para>
+ </footnote>
+ to get more information about the functions.
</para>
<para>After <ulink url="&url-wiki;Building">setting up a build environment</ulink> you can also generate
diff --git a/de/guide/ch_python_bindings.xml b/de/guide/ch_python_bindings.xml
index 74f9f09e..55524496 100644
--- a/de/guide/ch_python_bindings.xml
+++ b/de/guide/ch_python_bindings.xml
@@ -53,7 +53,7 @@ Translators:
<tip>
<para>This chapter is not about how to write your own &app-py; scripts. Refer to the
- <ulink url="&url-doc-api-main;python_bindings_page.html">developer documentation</ulink> for
+ <ulink url="&url-doc-api-stable;python_bindings_page.html">developer documentation</ulink> for
that instead.
</para>
</tip>
diff --git a/de/manual/ch_Reports.xml b/de/manual/ch_Reports.xml
index 5dee90c7..d743d430 100644
--- a/de/manual/ch_Reports.xml
+++ b/de/manual/ch_Reports.xml
@@ -3209,9 +3209,13 @@ Income (type INCOME)
<para>Because the above file only contains the syntax of the function you can use the nightly
<application>Doxygen</application> generated <acronym>API</acronym> documentation online for
- the <ulink url="&url-doc-api-main;">bugfix branch</ulink> or
- <ulink url="&url-doc-api-mast;">feature branch</ulink> to get more information about the
- functions.
+ the <ulink url="&url-doc-api-stable;">stable branch</ulink>
+ <footnote id='branch-future'>
+ <para>Nach der Implementierung des ersten Features der nächsten <emphasis>größeren</emphasis> Release
+ wird auch ein <ulink url="&url-doc-api-future;">future Zweig</ulink> erscheinen.
+ </para>
+ </footnote>
+ to get more information about the functions.
</para>
<para>After <ulink url="&url-wiki;Building">setting up a build environment</ulink> you can also generate
diff --git a/docbook/gnc-docbookx.dtd b/docbook/gnc-docbookx.dtd
index 2cf63410..b4f1442a 100644
--- a/docbook/gnc-docbookx.dtd
+++ b/docbook/gnc-docbookx.dtd
@@ -111,8 +111,8 @@ be used in normal text -->
<!ENTITY url-bug-search "https://bugs.gnucash.org/query.cgi">
<!ENTITY url-bug-browse "https://bugs.gnucash.org/describecomponents.cgi">
-<!ENTITY url-doc-api-main "&url-docs-draft;MAINT/">
-<!ENTITY url-doc-api-mast "&url-docs-draft;MASTER/">
+<!ENTITY url-doc-api-stable "&url-docs-draft;STABLE/">
+<!ENTITY url-doc-api-future "&url-docs-draft;FUTURE/">
<!-- Fixme: a dirty hack to reference the other document
Replace them after olink setup
append {guide|help}/<html-page> -->
diff --git a/it/guide/index.docbook b/it/guide/index.docbook
index 479c77e7..dc8e128f 100644
--- a/it/guide/index.docbook
+++ b/it/guide/index.docbook
@@ -18263,7 +18263,7 @@ Translators:
<tip>
<para>Questo capitolo non spiega come scrivere il proprio script di &app-py;. Per questo fare riferimento
- alla <ulink url="&url-doc-api-main;python_bindings_page.html">documentazione per gli
+ alla <ulink url="&url-doc-api-stable;python_bindings_page.html">documentazione per gli
sviluppatori</ulink>.
</para>
</tip>
diff --git a/it/manual/index.docbook b/it/manual/index.docbook
index 05e19c01..6c2b77c7 100644
--- a/it/manual/index.docbook
+++ b/it/manual/index.docbook
@@ -23537,14 +23537,28 @@ ________________________________________________________________________________
<para>Some users started a table in <ulink url="&url-wiki-api-custom;" />.
</para>
- <para>Because the above file only contains the syntax of the function you can use the Doxygen source
- documentation either local after running
+ <para>Because the above file only contains the syntax of the function you can use the nightly
+ <application>Doxygen</application> generated <acronym>API</acronym> documentation online for
+ the <ulink url="&url-doc-api-stable;">stable branch</ulink>
+ <footnote id='branch-future'>
+ <para>After the first feature of the next <emphasis>major</emphasis> release got implemented a
+ <ulink url="&url-doc-api-future;">future branch</ulink> will also appear.
+ </para>
+ </footnote>
+ to get more information about the functions.
+ </para>
+
+ <para>After <ulink url="&url-wiki;Building">setting up a build environment</ulink> you can also generate
+ it locally by running
<screen>
-./configure --enable-doxygen --enable-html-docs
+# make users:
make doc
+# ninja users:
+ninja doc
</screen>
- on your sources or online <ulink url="&url-doc-api-main;" /> or
- <ulink url="&url-doc-api-mast;" /> to get more information about the functions.
+ in your build directory and then open
+ <filename><replaceable>BUILDDIR</replaceable>/libgnucash/doc/html/index.html</filename> with
+ your preferred browser.
</para>
</sect2>
diff --git a/ru/guide/ch_python_bindings.xml b/ru/guide/ch_python_bindings.xml
index b84e1266..b119eb2e 100644
--- a/ru/guide/ch_python_bindings.xml
+++ b/ru/guide/ch_python_bindings.xml
@@ -51,7 +51,7 @@ Translators:
<tip>
<para>This chapter is not about how to write your own &app-py; scripts. Refer to the
- <ulink url="&url-doc-api-main;python_bindings_page.html">developer documentation</ulink> for
+ <ulink url="&url-doc-api-stable;python_bindings_page.html">developer documentation</ulink> for
that instead.
</para>
</tip>
diff --git a/zh/guide/ch_python_bindings.xml b/zh/guide/ch_python_bindings.xml
index 652ecb10..70681a44 100644
--- a/zh/guide/ch_python_bindings.xml
+++ b/zh/guide/ch_python_bindings.xml
@@ -50,7 +50,7 @@ Translators:
<tip>
<para>This chapter is not about how to write your own &app-py; scripts. Refer to the
- <ulink url="&url-doc-api-main;python_bindings_page.html">developer documentation</ulink> for
+ <ulink url="&url-doc-api-stable;python_bindings_page.html">developer documentation</ulink> for
that instead.
</para>
</tip>
Summary of changes:
C/guide/ch_python_bindings.xml | 2 +-
C/manual/ch_Reports.xml | 10 +++++++---
de/guide/ch_python_bindings.xml | 2 +-
de/manual/ch_Reports.xml | 10 +++++++---
docbook/gnc-docbookx.dtd | 4 ++--
it/guide/index.docbook | 2 +-
it/manual/index.docbook | 24 +++++++++++++++++++-----
ru/guide/ch_python_bindings.xml | 2 +-
zh/guide/ch_python_bindings.xml | 2 +-
9 files changed, 40 insertions(+), 18 deletions(-)
More information about the gnucash-changes
mailing list