diff --git a/docs/pages/0_mainpage.dox b/docs/pages/0_mainpage.dox new file mode 100644 index 00000000..2cc882d3 --- /dev/null +++ b/docs/pages/0_mainpage.dox @@ -0,0 +1,64 @@ +/** + * \mainpage Overview + * + * AqNWB is a C++ API for acquiring neurophysiological data directly into the NWB (Neurodata Without Borders) format. + * Our goal is to provide a lightweight API to integrate with existing acquisition systems. + * Below is a high-level overview of the project structure and capabilities we are targeting: + * + * \image html resources/images/aqnwb_objective.png "Project Overview" width=500px + * + * \section Status + * + * **AqNWB is currently under active development and should not yet be used in practice.** + * + * \htmlonly + *

+ * + * Unit tests + * + * + * Codespell + * + * + * Lint + * + * + * Docs build + * + *

+ *

+ * + * Source + * + * + * Code Stats + * + * + * Online Docs + * + *

+ * \endhtmlonly + * + * \section mainpage_installation Installation + * + * - \ref user_install_page "User Installation" + * - \ref dev_install_page "Developer Installation" + * + * \section mainpage_navigation Navigating the Documentation + * + * The documentation is divided into the following main sections: + * + * - \ref userdocs : This section is for users who want to use AqNWB in their software project, e.g., to + * integrate NWB with an acquisition system. + * - \ref devdocs : This section is for developers and community members who would like to + * contributed to the development of AqNWB. + * - **API Reference:** The [Namespaces](namespaces.html), [Classes](annotated.html), and [Files](files.html) + * sections are autogenerated from the AqNWB source code using Doxygen, providing a detailed reference of all + * classes, namespaces, files, functions, etc. defined by AqNWB. + * + * \section mainpage_contributing Contributing and Legal + * + * - \ref code_of_conduct_page + * - \ref license_page + * - \ref copyright_page + */ diff --git a/docs/pages/1_userdocs.dox b/docs/pages/1_userdocs.dox index c6a90b61..20ebced1 100644 --- a/docs/pages/1_userdocs.dox +++ b/docs/pages/1_userdocs.dox @@ -1,9 +1,9 @@ /** - * @page userdocs For Users + * \page userdocs For Users * * This documentation is intended for users of AqNWB, e.g., developers seeking to integrate NWB * with a particular data acquisition software via AqNWB. * - * - @subpage install_page - * - @subpage hdf5io + * - \subpage user_install_page + * - \subpage hdf5io */ diff --git a/docs/pages/2_devdocs.dox b/docs/pages/2_devdocs.dox index 7b868d38..f8a9d477 100644 --- a/docs/pages/2_devdocs.dox +++ b/docs/pages/2_devdocs.dox @@ -1,13 +1,13 @@ /** - * @page devdocs For Developers + * \page devdocs For Developers * * This documentation is intended for developers of AqNWB. * - * - @subpage dev_install_page - * - @subpage testing - * - @subpage dev_docs_page - * - @subpage code_of_conduct_page - * - @subpage license_page - * - @subpage copyright_page + * - \subpage dev_install_page + * - \subpage testing + * - \subpage dev_docs_page + * - \subpage code_of_conduct_page + * - \subpage license_page + * - \subpage copyright_page * */ diff --git a/docs/pages/devdocs/code_of_conduct.dox b/docs/pages/devdocs/code_of_conduct.dox index 24d0364f..632f7058 100644 --- a/docs/pages/devdocs/code_of_conduct.dox +++ b/docs/pages/devdocs/code_of_conduct.dox @@ -1,5 +1,5 @@ /** - * @page code_of_conduct_page Code of Conduct + * @page \ Code of Conduct * * This project and everyone participating in it is governed by our code of conduct guidelines. By participating, you are expected to uphold this code. * \include CODE_OF_CONDUCT.md diff --git a/docs/pages/devdocs/copyright.dox b/docs/pages/devdocs/copyright.dox index 8f6532be..f84e419b 100644 --- a/docs/pages/devdocs/copyright.dox +++ b/docs/pages/devdocs/copyright.dox @@ -1,5 +1,5 @@ /** - * @page copyright_page Copyright + * \page copyright_page Copyright * * \include Legal.txt */ diff --git a/docs/pages/devdocs/documentation.dox b/docs/pages/devdocs/documentation.dox index 0d33aa60..8a026761 100644 --- a/docs/pages/devdocs/documentation.dox +++ b/docs/pages/devdocs/documentation.dox @@ -1,5 +1,7 @@ /** - * @page dev_docs_page Documentation + * \page dev_docs_page Documentation + * + * \tableofcontents * * AqNWB uses [Doxygen](https://www.doxygen.nl/) with [Graphviz](https://graphviz.org/) for * documentation. The ``cmake`` related instructions on this page follow the @@ -27,12 +29,12 @@ * \par **docs/pages/userdocs/mypage.dox** * \code{.sh} * /** - * * @page mypage My New Page + * * \page mypage My New Page * * * */ * \endcode * - * and add a corresponding ``- @subpage mypage`` entry to the page listing of the ``docs/pages/1_userdocs.dox`` + * and add a corresponding ``- \subpage mypage`` entry to the page listing of the ``docs/pages/1_userdocs.dox`` * file. Note, the ``subpage`` command uses the label of the page (here ``mypage``) and not the name of the file. * * Similarly, we can add pages to the \ref devdocs docs by adding a new ``.dox`` file to the ``docs/pages/devdocs`` diff --git a/docs/pages/devdocs/install.dox b/docs/pages/devdocs/install.dox index 56a50558..f4816b9d 100644 --- a/docs/pages/devdocs/install.dox +++ b/docs/pages/devdocs/install.dox @@ -1,5 +1,7 @@ /** - * @page dev_install_page Installation & Setup + * \page dev_install_page Installation & Setup + * + * \tableofcontents * * \section dev_requirements_sec Requirements * diff --git a/docs/pages/devdocs/license.dox b/docs/pages/devdocs/license.dox index 7b57b4a5..a18d333f 100644 --- a/docs/pages/devdocs/license.dox +++ b/docs/pages/devdocs/license.dox @@ -1,5 +1,5 @@ /** - * @page license_page License + * \page license_page License * * \include LICENSE */ diff --git a/docs/pages/devdocs/testing.dox b/docs/pages/devdocs/testing.dox index 28244619..cfd81240 100644 --- a/docs/pages/devdocs/testing.dox +++ b/docs/pages/devdocs/testing.dox @@ -1,5 +1,7 @@ /** - * @page testing Testing + * \page testing Testing + * + * \tableofcontents * * \section testing_unit Unit Tests * diff --git a/docs/pages/userdocs/hdf5io.dox b/docs/pages/userdocs/hdf5io.dox index acd7b715..263e0f3b 100644 --- a/docs/pages/userdocs/hdf5io.dox +++ b/docs/pages/userdocs/hdf5io.dox @@ -1,5 +1,7 @@ /** - * @page hdf5io HDF5 I/O + * \page hdf5io HDF5 I/O + * + * \tableofcontents * * \section hdf5io_chunking Chunking * diff --git a/docs/pages/userdocs/install.dox b/docs/pages/userdocs/install.dox index 5dc204bd..435452fa 100644 --- a/docs/pages/userdocs/install.dox +++ b/docs/pages/userdocs/install.dox @@ -1,5 +1,5 @@ /** - * @page install_page Installing AqNWB + * \page \ Installing AqNWB * * \section user_requirements_sec Requirements * @@ -35,7 +35,3 @@ * */ - - - - */