Skip to content

Commit 287517b

Browse files
committed
try new documentation theme
1 parent 0cfa0a7 commit 287517b

File tree

6 files changed

+26
-8
lines changed

6 files changed

+26
-8
lines changed

.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
.idea
3+
4+
build/
5+
dist/
6+
7+
.venv/
8+
9+
.venv1/
10+
.github/
11+
12+
credentials.properties
13+
14+
pyPreservica.egg-info/

docs/api.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,9 @@ This part of the documentation covers all the interfaces of pyPreservica :class:
266266
.. py:currentmodule:: pyPreservica
267267
.. autofunction:: simple_asset_package
268268
.. autofunction:: complex_asset_package
269-
.. autofunction:: cvs_to_xml
269+
.. autofunction:: csv_to_xml
270+
.. autofunction:: csv_to_xsd
271+
.. autofunction:: csv_to_cmis_xslt
270272
.. autoclass:: UploadAPI
271273
:members:
272274

docs/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
master_doc = 'index'
99

10-
html_logo = "images/logo.png"
10+
html_logo = "images/trace.svg"
1111

1212
extensions = [
1313
'sphinx.ext.apidoc',
@@ -21,7 +21,9 @@
2121
'sphinxcontrib.googleanalytics'
2222
]
2323

24-
html_theme = "sphinx_rtd_theme"
24+
#html_theme = "sphinx_rtd_theme"
25+
26+
html_theme = "sphinx_clarity_theme"
2527

2628
html_extra_path = ["googled4940437d6a0a50d.html"]
2729

docs/index.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@ Welcome to pyPreservica's documentation
33

44
Release v\ |version|.
55

6-
..
7-
#image:: https://pepy.tech/badge/pyPreservica
8-
#target: https://pepy.tech/project/pyPreservica
6+
.. image:: https://pepy.tech/badge/pyPreservica
7+
:target: https://pepy.tech/project/pyPreservica
98

109
.. image:: https://img.shields.io/pypi/pyversions/pyPreservica.svg
1110
:target: https://pypi.org/project/pyPreservica/
@@ -22,7 +21,7 @@ Release v\ |version|.
2221

2322
**pyPreservica** is an open source, python client for the Preservica APIs
2423

25-
----------------------------
24+
-------------------------------------------------------------------------
2625

2726
pyPreservica is a 3rd party Python Software Development Kit (SDK) for the Preservica API,
2827
which allows Preservica users to write software that makes use of the Preservica repository services.

docs/intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ to be created to make the information accessible.
139139

140140
**Bitstreams** represent the actual computer files as ingested into Preservica, i.e. the TIFF photograph or the PDF document.
141141

142-
PIP Installation
142+
Installation
143143
----------------
144144

145145
pyPreservica is available from the Python Package Index (PyPI)

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ azure-storage-blob
1010
tqdm
1111
urllib3
1212
sphinx_rtd_theme
13+
sphinx_clarity_theme
1314
sphinxcontrib-googleanalytics

0 commit comments

Comments
 (0)