docs: reorganize directories; add goatcounter (#345)

dask-contrib · Aug 24, 2023 · b805680 · b805680
1 parent 0aeee53
commit b805680
Show file tree

Hide file tree

Showing 22 changed files with 241 additions and 64 deletions.
diff --git a/.gitignore b/.gitignore
@@ -92,7 +92,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-docs/generated/
+docs/**/generated/
 
 # PyBuilder
 target/

diff --git a/docs/api-collections.rst b/docs/api-collections.rst
diff --git a/docs/api-inspect.rst b/docs/api-inspect.rst
diff --git a/docs/api-reducers.rst b/docs/api-reducers.rst
diff --git a/docs/api-structure.rst b/docs/api-structure.rst
diff --git a/docs/api/collections.rst b/docs/api/collections.rst
@@ -0,0 +1,29 @@
+Collections
+-----------
+
+.. currentmodule:: dask_awkward
+
+.. autosummary::
+   :toctree: generated/
+
+   Array
+
+.. autosummary::
+   :toctree: generated/
+
+   Record
+
+.. autosummary::
+   :toctree: generated/
+
+   Scalar
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/api/inspect.rst b/docs/api/inspect.rst
@@ -0,0 +1,22 @@
+Inspection
+----------
+
+.. currentmodule:: dask_awkward
+
+.. autosummary::
+   :toctree: generated/
+
+   partition_compatibility
+   PartitionCompatibility
+   necessary_columns
+   sample
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/api-io.rst → docs/api/io.rst b/docs/api-io.rst → docs/api/io.rst
@@ -19,3 +19,14 @@ IO
    to_delayed
    to_parquet
    to_json
+
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/api/reducers.rst b/docs/api/reducers.rst
@@ -0,0 +1,16 @@
+Reducers
+--------
+
+Reduction functions from the awkward-array API. Dedicated Dask
+specific API documentation will be added here; for now please consult
+the awkward-array API docs.
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/api/structure.rst b/docs/api/structure.rst
@@ -0,0 +1,17 @@
+Structure
+---------
+
+Structure functions from the awkward-array API. Dedicated Dask
+specific API documentation will be added here; for now please consult
+the awkward-array API docs.
+
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/dev-contributing.rst → docs/dev/contributing.rst b/docs/dev-contributing.rst → docs/dev/contributing.rst
@@ -50,3 +50,13 @@ rendered.
 
 .. _issuetracker: https://github.com/dask-contrib/dask-awkward/issues
 .. _precommit: https://pre-commit.com/
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/dev-releasing.rst → docs/dev/releasing.rst b/docs/dev-releasing.rst → docs/dev/releasing.rst
@@ -59,3 +59,14 @@ Merge conda-forge version update
 The conda-forge ``regro-cf-autotick-bot`` will create a PR after
 detecting the new release on PyPI. You should be able to just merge
 the PR when CI passes.
+
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/gs-install.rst → docs/getting-started/install.rst b/docs/gs-install.rst → docs/getting-started/install.rst
@@ -22,3 +22,13 @@ If you'd like to install dask-awkward from the latest commit to the
 .. code:: none
 
    pip install git+https://github.com/dask-contrib/dask-awkward@main
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/gs-intro.rst → docs/getting-started/intro.rst b/docs/gs-intro.rst → docs/getting-started/intro.rst
@@ -78,3 +78,14 @@ For example usage of dask-awkward, `we have a demo repository
 
 .. _Awkward-Array: https://awkward-array.org/
 .. _Dask: https://dask.org/
+
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/gs-limitations.rst → docs/getting-started/limitations.rst b/docs/gs-limitations.rst → docs/getting-started/limitations.rst
@@ -20,3 +20,13 @@ operations under this umbrella:
 3. **Things that just won't be implemented**: There will be parts of
    the dask-awkward API that we simply cannot implement for lazy
    computation!
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/gs-terminology.rst → docs/getting-started/terminology.rst b/docs/gs-terminology.rst → docs/getting-started/terminology.rst
@@ -41,3 +41,14 @@ In written descriptions, we'll sometimes refer to the awkward-array
 Finally, the result of calling the ``compute()`` method on a
 ``dak.Array`` object will almost always result in an ``ak.Array``
 object.
+
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/ht-behaviors.rst → docs/how-to/behaviors.rst b/docs/ht-behaviors.rst → docs/how-to/behaviors.rst
@@ -60,3 +60,13 @@ topic).
    result = distance.compute()
 
 .. _behaviors: https://awkward-array.org/doc/main/reference/ak.behavior.html
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/ht-configuration.rst → docs/how-to/configuration.rst b/docs/ht-configuration.rst → docs/how-to/configuration.rst
@@ -57,5 +57,15 @@ For example, they can be set with the form:
   the optimization. If set to ``raise``, raise an exception at
   optimization time. If set to ``pass``, silently skip the
   optimization. More information can be found in the :ref:`necessary
-  columns optimization <me-optimization:necessary columns>` section of
+  columns optimization <more/optimization:necessary columns>` section of
   the docs.
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/ht-io.rst → docs/how-to/io.rst b/docs/ht-io.rst → docs/how-to/io.rst
@@ -30,5 +30,15 @@ awkward Array instances or Python lists.
 
 .. _Uproot: https://github.com/scikit-hep/uproot5
 
-See the :ref:`IO API docs<api-io:IO>` page for more information on the
+See the :ref:`IO API docs<api/io:IO>` page for more information on the
 possible ways to instantiate a new dask-awkward Array.
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,46 +20,57 @@ Table of Contents
    :maxdepth: 1
    :caption: Getting Started
 
-   gs-install.rst
-   gs-intro.rst
-   gs-terminology.rst
-   gs-limitations.rst
+   getting-started/install.rst
+   getting-started/intro.rst
+   getting-started/terminology.rst
+   getting-started/limitations.rst
 
 .. toctree::
    :maxdepth: 1
    :caption: How Tos
 
-   ht-configuration.rst
-   ht-io.rst
-   ht-behaviors.rst
+   how-to/configuration.rst
+   how-to/io.rst
+   how-to/behaviors.rst
 
 .. toctree::
    :maxdepth: 1
    :caption: Deeper Explanation
 
-   me-optimization.rst
-   me-faq.rst
+   more/optimization.rst
+   more/faq.rst
 
 .. toctree::
    :maxdepth: 1
    :caption: API
 
-   api-collections.rst
-   api-inspect.rst
-   api-io.rst
-   api-reducers.rst
-   api-structure.rst
+   api/collections.rst
+   api/inspect.rst
+   api/io.rst
+   api/reducers.rst
+   api/structure.rst
 
 .. toctree::
    :maxdepth: 1
    :caption: Development
 
-   dev-contributing.rst
-   dev-releasing.rst
+   dev/contributing.rst
+   dev/releasing.rst
 
 ------------
 
 Support for this work was provided by NSF grant `OAC-2103945 <nsf_>`_.
 
 .. _awkwardarray: https://awkward-array.org/
 .. _nsf: https://www.nsf.gov/awardsearch/showAward?AWD_ID=2103945
+
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>
diff --git a/docs/me-faq.rst → docs/more/faq.rst b/docs/me-faq.rst → docs/more/faq.rst
@@ -20,7 +20,7 @@ what does this mean?**
 
     You can read more about the optimization and how to configure it
     (by either silencing the warning or raise the exception) at
-    :doc:`this section of the docs <me-optimization>`. Please open an
+    :doc:`this section of the docs <optimization>`. Please open an
     issue on the GitHub issue tracker if you think you've found a
     failure in the optimization that should be fixed.
 
@@ -49,3 +49,13 @@ on the first partition will occur." what does that mean?**
 
 
 .. _daskconfig: https://docs.dask.org/en/stable/configuration.html
+
+.. raw:: html
+
+    <script>
+        window.goatcounter = {
+            path: function(p) { return location.host + p }
+        }
+    </script>
+    <script data-goatcounter="https://distdatacats.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>