diff --git a/docs/source/apiReference.md b/docs/source/apiReference.md index 2bb431b4..79dda40c 100644 --- a/docs/source/apiReference.md +++ b/docs/source/apiReference.md @@ -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 @@ -75,6 +90,8 @@ Arrays, Matrices and Linear Algebra Vectors Complex Numbers Sets +Bitset +Map Mathematics Multi-Precision Arithmetic Utilities diff --git a/docs/source/bitset/bitset.md b/docs/source/bitset/bitset.md new file mode 100644 index 00000000..2b3f992d --- /dev/null +++ b/docs/source/bitset/bitset.md @@ -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 + Examples + Implementation Details +``` diff --git a/docs/source/bitset/bitsetListing.md b/docs/source/bitset/bitsetListing.md new file mode 100644 index 00000000..910ad61d --- /dev/null +++ b/docs/source/bitset/bitsetListing.md @@ -0,0 +1,4 @@ +# Bitset Listing + +```{doxygenfile} librapid/include/librapid/datastructures/bitset.hpp +``` diff --git a/docs/source/bitset/examples.md b/docs/source/bitset/examples.md new file mode 100644 index 00000000..51d4e388 --- /dev/null +++ b/docs/source/bitset/examples.md @@ -0,0 +1,3 @@ +# Bitset Examples + +*To do* diff --git a/docs/source/bitset/implementation.md b/docs/source/bitset/implementation.md new file mode 100644 index 00000000..be8c262d --- /dev/null +++ b/docs/source/bitset/implementation.md @@ -0,0 +1,3 @@ +# Bitset Implementation Details + +*To do* \ No newline at end of file diff --git a/docs/source/utilities/map.md b/docs/source/map/map.md similarity index 55% rename from docs/source/utilities/map.md rename to docs/source/map/map.md index 9315ded9..032a29b5 100644 --- a/docs/source/utilities/map.md +++ b/docs/source/map/map.md @@ -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 ``` diff --git a/pyproject.toml b/pyproject.toml index 69ef7efa..9ad7c971 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,6 +24,7 @@ sdist.exclude = [ "CMakeFiles", "build", "dist", + "librapid/vendor", "*.h", "*.c", "*.hpp", @@ -38,6 +39,13 @@ sdist.exclude = [ "*.dll", "*.doc", "*.tgz", + "*.md", + "*.yml", + "*.yaml", + "*.in", + "*.rst", + "*.sh", + "*.html" ] [project]