diff --git a/README.md b/README.md index a54f6d0a..ce788b7a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ # Anatomical Fiducials (AFIDs) Utility Tools -[![Documentation Status](https://readthedocs.org/projects/afids-utils/badge/?version=latest)](https://afids-utils.readthedocs.io/en/latest/?badge=latest) \ No newline at end of file +[![Documentation Status](https://readthedocs.org/projects/afids-utils/badge/?version=latest)](https://afids-utils.readthedocs.io/en/latest/?badge=latest) + +The `afids_utils` package provides common utilities for projects involving +anatomical fiducials (AFIDs). For a comprehensive list of available utilities +refer to the [documentation](https://afids-utils.readthedocs.io/en/stable) +page. \ No newline at end of file diff --git a/docs/general/main.md b/docs/general/main.md deleted file mode 100644 index 673e1a2f..00000000 --- a/docs/general/main.md +++ /dev/null @@ -1,33 +0,0 @@ -# Overview - -The purpose of the `afids_utils` package is to provide commonly used utility -functions (written in Python) that is applicable to a various anatomical -fiducial (AFIDS) projects. The `afids_utils` documentation provides a -comprehensive reference guide designed to assist users and developers in -effectively utilizing the functionalities provided by the package's -application programming interface (API). It serves as a centralized resource -that offers detailed information about the various modules, classes, functions, -and constants available within the `afids_utils` package. - -Following the introduction, the API Reference pages provide a structured -organization of the package's modules and classes. Each module is described, explaining its role and the specific functionalities it offers. Detailed -information is provided for each class, including its methods, attributes, and -inheritance hierarchy, along with explanations of their purposes and usage. - -Additionally, the API page includes comprehensive documentation for the -functions and constants within the package. It describes the parameters -expected by each function, their data types, and their respective return -values. The documentation also highlights any optional parameters, default -values, and notable exceptions that may be raised. - -To assist developers in understanding and effectively utilizing the -`afids_utils` package, the API page may include code examples that -demonstrate the practical usage of the various modules, classes, functions, -and constants. These examples showcase common use cases, allowing developers -to grasp the concepts quickly and integrate them into their own projects. - -Furthermore, the API page may provide guidelines and best practices specific to -the `afids_utils` package. It may include recommendations on code structure, -error handling, performance optimization, and any other considerations that can -enhance the developer experience and ensure reliable and efficient usage of the -package. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index f8cdc82d..3beca1fb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,15 +1,6 @@ ```{include} ../README.md ``` -```{toctree} -:caption: General -:name: general -:hidden: -:maxdepth: 2 - -general/main -``` - ```{toctree} :caption: API Reference :name: api_reference