Skip to content

Commit f290c17

Browse files
committed
Add python-blosc2.rst
1 parent 8353bb5 commit f290c17

File tree

2 files changed

+82
-81
lines changed

2 files changed

+82
-81
lines changed

doc/index.rst

Lines changed: 1 addition & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1 @@
1-
Python-Blosc2 documentation
2-
============================
3-
4-
Python-Blosc2 is a Python package
5-
that wraps C-Blosc2, the newest version of the Blosc compressor.
6-
7-
.. panels::
8-
:card: + intro-card text-center
9-
:column: col-lg-6 col-md-12 col-sm-12 col-xs-12 d-flex
10-
11-
---
12-
13-
Getting Started
14-
^^^^^^^^^^^^^^^
15-
16-
New to Python-Blosc2? Check out the getting started guides. They contain an
17-
introduction to Python-Blosc2 main concepts and an installation tutorial.
18-
19-
+++
20-
21-
.. link-button:: getting_started/index
22-
:type: ref
23-
:text: To the getting started guides
24-
:classes: btn-info
25-
26-
---
27-
28-
API Reference
29-
^^^^^^^^^^^^^
30-
31-
The reference guide contains a detailed description of the Python-Blosc2 API.
32-
The reference describes how the functions work and which parameters can
33-
be used.
34-
35-
+++
36-
37-
.. link-button:: reference/index
38-
:type: ref
39-
:text: To the reference guide
40-
:classes: btn-info
41-
42-
43-
---
44-
45-
Development
46-
^^^^^^^^^^^
47-
48-
Saw a typo in the documentation? Want to improve
49-
existing functionalities? The contributing guidelines will guide
50-
you through the process of improving Python-Blosc2.
51-
52-
+++
53-
54-
.. link-button:: development/index
55-
:type: ref
56-
:text: To the development guide
57-
:classes: btn-info
58-
59-
---
60-
61-
Release Notes
62-
^^^^^^^^^^^^^
63-
64-
Want to see what's new in the latest release? Check out the release notes to find out!
65-
66-
+++
67-
68-
.. link-button:: release_notes/index
69-
:type: ref
70-
:text: To the release notes
71-
:classes: btn-info
72-
73-
74-
.. toctree::
75-
:maxdepth: 1
76-
:hidden:
77-
78-
Getting Started <getting_started/index>
79-
API Reference <reference/index>
80-
Development <development/index>
81-
Release Notes <release_notes/index>
1+
.. include:: python-blosc2.rst

doc/python-blosc2.rst

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
Python-Blosc2 documentation
2+
============================
3+
4+
Python-Blosc2 is a Python package
5+
that wraps C-Blosc2, the newest version of the Blosc compressor.
6+
7+
.. panels::
8+
:card: + intro-card text-center
9+
:column: col-lg-6 col-md-12 col-sm-12 col-xs-12 d-flex
10+
11+
---
12+
13+
Getting Started
14+
^^^^^^^^^^^^^^^
15+
16+
New to Python-Blosc2? Check out the getting started guides. They contain an
17+
introduction to Python-Blosc2 main concepts and an installation tutorial.
18+
19+
+++
20+
21+
.. link-button:: getting_started/index
22+
:type: ref
23+
:text: To the getting started guides
24+
:classes: btn-info
25+
26+
---
27+
28+
API Reference
29+
^^^^^^^^^^^^^
30+
31+
The reference guide contains a detailed description of the Python-Blosc2 API.
32+
The reference describes how the functions work and which parameters can
33+
be used.
34+
35+
+++
36+
37+
.. link-button:: reference/index
38+
:type: ref
39+
:text: To the reference guide
40+
:classes: btn-info
41+
42+
43+
---
44+
45+
Development
46+
^^^^^^^^^^^
47+
48+
Saw a typo in the documentation? Want to improve
49+
existing functionalities? The contributing guidelines will guide
50+
you through the process of improving Python-Blosc2.
51+
52+
+++
53+
54+
.. link-button:: development/index
55+
:type: ref
56+
:text: To the development guide
57+
:classes: btn-info
58+
59+
---
60+
61+
Release Notes
62+
^^^^^^^^^^^^^
63+
64+
Want to see what's new in the latest release? Check out the release notes to find out!
65+
66+
+++
67+
68+
.. link-button:: release_notes/index
69+
:type: ref
70+
:text: To the release notes
71+
:classes: btn-info
72+
73+
74+
.. toctree::
75+
:maxdepth: 1
76+
:hidden:
77+
78+
Getting Started <getting_started/index>
79+
API Reference <reference/index>
80+
Development <development/index>
81+
Release Notes <release_notes/index>

0 commit comments

Comments
 (0)