Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Pencilcaseman committed Oct 23, 2023
1 parent bc9d892 commit 5018210
Show file tree
Hide file tree
Showing 7 changed files with 74 additions and 3 deletions.
17 changes: 17 additions & 0 deletions docs/source/apiReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,21 @@ Complex numbers and their operations.
Mathematical sets.
:::

:::{grid-item-card} {octicon}`stack` Bitset
:link: bitset/bitset
:link-type: doc

Optimised arrays of Boolean values with support for
bitwise operations.
:::

:::{grid-item-card} {octicon}`book` Maps
:link: map.map
:link-type: doc

Maps and dictionary-like objects.
:::

:::{grid-item-card} {octicon}`number` Mathematics
:link: math/math
:link-type: doc
Expand Down Expand Up @@ -75,6 +90,8 @@ Arrays, Matrices and Linear Algebra <array/array>
Vectors <vector/vector>
Complex Numbers <complex/complex>
Sets <set/set>
Bitset <bitset/bitset>
Map <map/map>
Mathematics <math/math>
Multi-Precision Arithmetic <multiPrecision/multiPrecision>
Utilities <utility/utility>
Expand Down
36 changes: 36 additions & 0 deletions docs/source/bitset/bitset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Bitset

::::{grid} 1 2 2 3
:margin: 4 4 0 0
:gutter: 1

:::{grid-item-card} {octicon}`cpu` Documentation
:link: bitsetListing
:link-type: doc

View the API and documentation for LibRapid Sets.
:::

:::{grid-item-card} {octicon}`tools` Examples
:link: examples
:link-type: doc

See some examples of LibRapid's Set library in action
:::

:::{grid-item-card} {octicon}`tools` Implementation Details
:link: implementation
:link-type: doc

Learn about how LibRapid's Bitset library is implemented
:::
::::

```{toctree}
:hidden:
:maxdepth: 3
Documentation <bitsetListing>
Examples <examples>
Implementation Details <implementation>
```
4 changes: 4 additions & 0 deletions docs/source/bitset/bitsetListing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Bitset Listing

```{doxygenfile} librapid/include/librapid/datastructures/bitset.hpp
```
3 changes: 3 additions & 0 deletions docs/source/bitset/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Bitset Examples

*To do*
3 changes: 3 additions & 0 deletions docs/source/bitset/implementation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Bitset Implementation Details

*To do*
6 changes: 3 additions & 3 deletions docs/source/utilities/map.md → docs/source/map/map.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Both of these classes inherit from the ``std::map`` and ``std::unordered_map`` c
few additional features to make them easier to use and more versatile.

For the full documentation on the ``std::map`` and ``std::unordered_map`` classes, see
the [C++ reference](https://en.cppreference.com/w/cpp/container/map)
and [C++ reference](https://en.cppreference.com/w/cpp/container/unordered_map) pages.
the [map (C++ reference)](https://en.cppreference.com/w/cpp/container/map)
and [unordered map (C++ reference)](https://en.cppreference.com/w/cpp/container/unordered_map) pages.

```{doxygenfile} librapid/include/librapid/utilities/map.hpp
```{doxygenfile} librapid/include/librapid/datastructures/map.hpp
```
8 changes: 8 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ sdist.exclude = [
"CMakeFiles",
"build",
"dist",
"librapid/vendor",
"*.h",
"*.c",
"*.hpp",
Expand All @@ -38,6 +39,13 @@ sdist.exclude = [
"*.dll",
"*.doc",
"*.tgz",
"*.md",
"*.yml",
"*.yaml",
"*.in",
"*.rst",
"*.sh",
"*.html"
]

[project]
Expand Down

0 comments on commit 5018210

Please sign in to comment.