Skip to content

Commit ef37b18

Browse files
committed
Updated documentation and docset
1 parent bd7f6ab commit ef37b18

File tree

9 files changed

+30
-4
lines changed

9 files changed

+30
-4
lines changed

docs/changelog.txt

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Version 1.4.1
66
=============
77

88
* Fix: uregistered bug in trace.TraceConfig - redundant `flags` definition.
9-
* New: Documentation now contains `Dash` / `Zeal` docset.
9+
* New: Documentation is now also provided as Dash_ / Zeal_ docset, downloadable from releases_ at github.
1010

1111
Version 1.4.0
1212
=============
@@ -148,3 +148,7 @@ Version 0.5.0
148148
=============
149149

150150
Initial release.
151+
152+
.. _releases: https://github.com/FirebirdSQL/python3-base/releases
153+
.. _Dash: https://kapeli.com/dash
154+
.. _Zeal: https://zealdocs.org/

docs/firebird-base.docset/Contents/Resources/Documents/_sources/changelog.txt

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Version 1.4.1
66
=============
77

88
* Fix: uregistered bug in trace.TraceConfig - redundant `flags` definition.
9-
* New: Documentation now contains `Dash` / `Zeal` docset.
9+
* New: Documentation is now also provided as Dash_ / Zeal_ docset, downloadable from releases_ at github.
1010

1111
Version 1.4.0
1212
=============
@@ -148,3 +148,7 @@ Version 0.5.0
148148
=============
149149

150150
Initial release.
151+
152+
.. _releases: https://github.com/FirebirdSQL/python3-base/releases
153+
.. _Dash: https://kapeli.com/dash
154+
.. _Zeal: https://zealdocs.org/

docs/firebird-base.docset/Contents/Resources/Documents/_sources/index.txt

+6
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ Topic covered by `firebird-base` package:
2323

2424
.. note:: Requires Python 3.8+
2525

26+
.. tip:: You can download docset fro Dash_ (MacOS) or Zeal_ (Windows / Linux) documentation
27+
readers from releases_ at github.
28+
2629
.. toctree::
2730
:maxdepth: 1
2831
:includehidden:
@@ -40,3 +43,6 @@ Topic covered by `firebird-base` package:
4043
|
4144

4245
.. _Firebird Project: http://www.firebirdsql.org
46+
.. _releases: https://github.com/FirebirdSQL/python3-base/releases
47+
.. _Dash: https://kapeli.com/dash
48+
.. _Zeal: https://zealdocs.org/
Loading

docs/firebird-base.docset/Contents/Resources/Documents/changelog.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
123123
<h2>Version 1.4.1<a class="headerlink" href="#version-1-4-1" title="Permalink to this heading"></a></h2>
124124
<ul class="simple">
125125
<li><p>Fix: uregistered bug in trace.TraceConfig - redundant <code class="xref py py-obj docutils literal notranslate"><span class="pre">flags</span></code> definition.</p></li>
126-
<li><p>New: Documentation now contains <code class="xref py py-obj docutils literal notranslate"><span class="pre">Dash</span></code> / <code class="xref py py-obj docutils literal notranslate"><span class="pre">Zeal</span></code> docset.</p></li>
126+
<li><p>New: Documentation is now also provided as <a class="reference external" href="https://kapeli.com/dash">Dash</a> / <a class="reference external" href="https://zealdocs.org/">Zeal</a> docset, downloadable from <a class="reference external" href="https://github.com/FirebirdSQL/python3-base/releases">releases</a> at github.</p></li>
127127
</ul>
128128
</section>
129129
<section id="version-1-4-0">

docs/firebird-base.docset/Contents/Resources/Documents/index.html

+5
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,11 @@ <h1>The Firebird Base library for Python<a class="headerlink" href="#the-firebir
128128
<p class="admonition-title">Note</p>
129129
<p>Requires Python 3.8+</p>
130130
</div>
131+
<div class="admonition tip">
132+
<p class="admonition-title">Tip</p>
133+
<p>You can download docset fro <a class="reference external" href="https://kapeli.com/dash">Dash</a> (MacOS) or <a class="reference external" href="https://zealdocs.org/">Zeal</a> (Windows / Linux) documentation
134+
readers from <a class="reference external" href="https://github.com/FirebirdSQL/python3-base/releases">releases</a> at github.</p>
135+
</div>
131136
<div class="toctree-wrapper compound">
132137
</div>
133138
<div class="toctree-wrapper compound">

docs/firebird-base.docset/Contents/Resources/Documents/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/index.txt

+6
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ Topic covered by `firebird-base` package:
2323

2424
.. note:: Requires Python 3.8+
2525

26+
.. tip:: You can download docset fro Dash_ (MacOS) or Zeal_ (Windows / Linux) documentation
27+
readers from releases_ at github.
28+
2629
.. toctree::
2730
:maxdepth: 1
2831
:includehidden:
@@ -40,3 +43,6 @@ Topic covered by `firebird-base` package:
4043
|
4144

4245
.. _Firebird Project: http://www.firebirdsql.org
46+
.. _releases: https://github.com/FirebirdSQL/python3-base/releases
47+
.. _Dash: https://kapeli.com/dash
48+
.. _Zeal: https://zealdocs.org/

docs/make-docset

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
doc2dash -u https://firebird-base.readthedocs.io/en/latest/ -f -i ./_static/fb-favicon.png -n firebird-base ./_build/html/
2+
tar --exclude='.DS_Store' -cvzf ../firebird-base.tgz firebird-base.docset

0 commit comments

Comments
 (0)