diff --git a/docs/notebooks/README.md b/docs/notebooks/README.md deleted file mode 100644 index 2b4fb45..0000000 --- a/docs/notebooks/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# Jupyter notebooks to run on-demand. - -Jupyter notebooks in this directory will be run each time you render your documentation. - -This means they should be able to be run with the resources in the repo, and in various environments: - -- any other developer's machine -- github CI runners -- ReadTheDocs doc generation - -This is great for notebooks that can run in a few minutes, on smaller datasets. - -If you would like to include these notebooks in automatically generated documentation -simply add the notebook name to the ``../notebooks.rst`` file, and include a markdown -cell at the beginning of your notebook with ``# Title`` that will be used as the text -in the table of contents in the documentation. - -Be aware that you may also need to update the ``../requirements.txt`` file if -your notebooks have dependencies that are not specified in ``../pyproject.toml``. - -For notebooks that require large datasets, access to third party APIs, large CPU or GPU requirements, put them in `./pre_executed` instead. - -For more information look here: https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks - -Or if you still have questions contact us: https://lincc-ppt.readthedocs.io/en/latest/source/contact.html \ No newline at end of file diff --git a/docs/pre_executed/README.md b/docs/pre_executed/README.md deleted file mode 100644 index fb3cc7c..0000000 --- a/docs/pre_executed/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Pre-executed Jupyter notebooks - -Jupyter notebooks in this directory will NOT be run in the docs workflows, and will be rendered with -the provided output cells as-is. - -This is useful for notebooks that require large datasets, access to third party APIs, large CPU or GPU requirements. - -Where possible, instead write smaller notebooks that can be run as part of a github worker, and within the ReadTheDocs rendering process. - -To ensure that the notebooks are not run by the notebook conversion process, you can add the following metadata block to the notebook: - -``` - "nbsphinx": { - "execute": "never" - }, -``` diff --git a/src/nested_pandas/example_benchmarks.py b/src/nested_pandas/example_benchmarks.py deleted file mode 100644 index 78da46a..0000000 --- a/src/nested_pandas/example_benchmarks.py +++ /dev/null @@ -1,14 +0,0 @@ -"""An example module containing simplistic methods under benchmarking.""" - -import random -import time - - -def runtime_computation() -> None: - """Runtime computation consuming between 0 and 5 seconds.""" - time.sleep(random.uniform(0, 5)) - - -def memory_computation() -> list[int]: - """Memory computation for a random list up to 512 samples.""" - return [0] * random.randint(0, 512)