Showcasing the changes made to generate a PDF with Sphinx

admin-manual/index.rst

@@ -3,8 +3,6 @@ Administrator manual
 ====================
 
 .. toctree::
-
-   installation/index
-   maintenance/index
-   customization/index
-   security/index
+    :glob:
+
+    */*

conf.py

@@ -87,7 +87,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["_build", ".env"]
+exclude_patterns = ["_build", ".env", ".venv"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None

dev-manual/index.rst

@@ -8,13 +8,9 @@ Below you'll find an outline of the chapters in the Developer's manual, and a
 set of links to each chapter's main sections.
 
 .. toctree::
-
-   env/vagrant
-   env/compose
-   api/api-intro
-   api/browse-taxonomies
-   api/browse-io
-   api/read-io
-   api/download-do
+    :glob:
+
+    api/*
+    env/*
 
 :ref:`Back to top <dev-manual-index>`

index.rst

@@ -4,282 +4,9 @@
 AtoM documentation
 ==================
 
-.. _user-manual-home:
-
-User manual
-===========
-
-User guide to creating, editing, accessing, importing, exporting, and
-translating content in AtoM; includes administering the system via the
-:term:`user interface`.
-
-.. _overview:
-
-Overview
---------
-
-This section provides an overview of the technical architecture and
-requirements.
-
-* :doc:`What is AtoM? <user-manual/overview/intro>`
-* :doc:`Technical requirements <user-manual/overview/technical-requirements>`
-* :doc:`Entity types <user-manual/overview/entity-types>`
-* :doc:`Descriptive standards <user-manual/overview/descriptive-standards>`
-
-.. _getting-started:
-
-Getting started
-----------------
-
-This section describes how to start using AtoM once it has been installed. It
-provides a quick orientation to the home page, how to log in and log out, the
-various user roles in the system, the main page types a user will encounter, and
-how to switch languages.
-
-* :ref:`Home page <home-page>`
-* :ref:`Log in <log-in>`
-* :ref:`User roles <user-roles>`
-* :ref:`Page types <page-types>`
-* :ref:`Choose language <choose-language>`
-* :ref:`Change password <change-password>`
-
-.. _add-edit-content:
-
-Add/edit content
-----------------
-
-This section describes how to add, edit, and delete content in AtoM.
-
-* :ref:`Accession records <accession-records>`
-* :ref:`Archival descriptions <archival-descriptions>`
-* :ref:`Authority records <authority-records>`
-* :ref:`Archival institutions <archival-institutions>`
-* :ref:`Deaccession records <deaccessions>`
-* :ref:`Donors <donors>`
-* :ref:`Functions <functions>`
-* :ref:`Rights <rights>`
-* :ref:`Control area <control-area>`
-* :ref:`Terms <terms>`
-* :ref:`Physical storage <physical-storage>`
-* :ref:`formatting`
-* :ref:`Exit edit mode <exit-edit-mode>`
-
-.. _access-content:
-
-Access content
---------------
-
-This section provides guidelines for searching, browsing, and navigating. Most
-of the functions discussed are available to all :ref:`user roles <user-roles>`,
-including :ref:`researchers <user-researcher>` with read only access. However,
-some navigation features (e.g. edit mode), are only available to users with
-edit :term:`access privileges <access privilege>`.
-
-* :ref:`Search <search-atom>`
-* :ref:`Advanced search <advanced-search>`
-* :ref:`Browse <browse>`
-* :ref:`Navigate <navigate>`
-* :ref:`Context menu <context-menu>`
-* :ref:`clipboard`
-
-.. _translate:
-
-Translate
----------
-
-This section describes how to translate both database content and
-:term:`user interface` elements in AtoM.
-
-* :ref:`multilingual-design-principles`
-* :ref:`Translate content <translate-content>`
-* :ref:`Translate interface <translate-interface>`
-* :ref:`translate-static-pages`
-
-
-.. _reports-printing:
-
-Reports/printing
-----------------
-
-This section describes how to create and print different types of reports using
-AtoM:
-
-* :ref:`file-item-reports`
-* :ref:`create-physical-storage-report`
-* :ref:`print-finding-aids`
-
-
-.. _import-export:
-
-Import/export
--------------
-
-This section describes automated methods for getting data in and out of an AtoM
-application.
-
-* :ref:`Upload digital objects <upload-digital-object>`
-* :ref:`import-xml`
-* :ref:`export-xml`
-* :ref:`csv-validation`
-* :ref:`csv-import`
-* :ref:`csv-export`
-* :ref:`import-export-skos`
-* :ref:`oai-pmh`
-
-.. _administer:
-
-Administer
-----------
-
-This section describes how to administer AtoM, whether for a single institution
-or for a :term:`network`.
-
-* :ref:`Manage user accounts and user groups <manage-user-accounts>`
-* :ref:`Manage digital object storage <manage-digital-object-storage>`
-* :ref:`Edit user permissions <edit-user-permissions>`
-* :ref:`manage-jobs`
-* :ref:`Manage static pages <manage-static-pages>`
-* :ref:`Manage menus <manage-menus>`
-* :ref:`Manage plugins <manage-plugins>`
-* :ref:`Settings <settings>`
-* :ref:`Themes and theming <themes>`
-* :ref:`Default language <default-language>`
-* :ref:`Site logo <site-logo>`
-* :ref:`Search for updates <search-updates>`
-* :ref:`Visible elements <visible-elements>`
-
-.. _data-entry:
-
-Data entry / templates
------------------------
-
-This section includes specific instructions on working with AtoM's
-standards-based edit templates. Data entry guidance is provided based on
-guidance from the relevant standard, notes on each :term:`field's <field>` use
-in AtoM, and more.
-
-* **Archival description templates**
-
-  * :ref:`ISAD(G) template <isad-template>`
-  * :ref:`RAD template <rad-template>`
-  * :ref:`DACS template <dacs-template>`
-  * :ref:`Dublin Core template <dc-template>`
-  * :ref:`MODS template <mods-template>`
-
-* **Authority record templates**
-
-  * :ref:`ISAAR-CPF template <isaar-template>`
-
-* **Archival institution templates**
-
-  * :ref:`ISDIAH template <isdiah-template>`
-
-* **Archival function templates**
-
-  * :ref:`ISDF template <isdf-template>`
-
-* **Rights record templates**
-
-  * :ref:`PREMIS template <premis-template>`
-
-Glossary
---------
-
-Glossary of terms used throughout this user manual.
-
-* :doc:`Glossary <user-manual/glossary/glossary>`
-
-.. _admin-manual-home:
-
-Administrator manual
-====================
-
-Instructions for installing, upgrading, importing and more; includes
-administering the system via the command-line interface.
-
-.. _admin-installation:
-
-Installation
-------------
-
-* :ref:`installation-intended-audience`
-* :ref:`installation-requirements`
-* :ref:`installation-ubuntu`
-* :ref:`installation-windows`
-* :ref:`installation-macosx`
-* :ref:`installation-ansible`
-* :ref:`installation-upgrading`
-* :ref:`installation-execution-limits`
-
-
-.. _admin-maintenance:
-
-Maintenance
------------
-
-* :ref:`maintenance-cli-tools`
-* :ref:`cli-import-export`
-* :ref:`maintenance-clear-cache`
-* :ref:`maintenance-web-analytics`
-* :ref:`maintenance-logging`
-* :ref:`maintenance-monitoring`
-* :ref:`maintenance-populate-search-index`
-* :ref:`maintenance-data-backup`
-* :ref:`common-atom-queries`
-* :ref:`maintenance-tuning`
-* :ref:`maintenance-asynchronous-jobs`
-* :ref:`maintenance-troubleshooting`
-* :ref:`debug-mode`
-* :ref:`maintenance-elasticsearch`
-
-.. _admin-customization:
-
-Customization
--------------
-
-* :ref:`customization-config-files`
-* :ref:`customization-theming`
-* :ref:`customization-watermarking`
-* :ref:`customization-authentication`
-* :ref:`customization-localization`
-
-.. _admin-security:
-
-Security
---------
-
-* :ref:`security-application`
-* :ref:`security-firewall`
-* :ref:`security-backups`
-
-.. _dev-manual-home:
-
-Developer's manual
-==================
-
-Guidelines for developers interested in customizing AtoM, developing new
-modules, and working with the application's API.
-
-.. _dev-env-home:
-
-Environments
-------------
-
-We provide two developer-friendly environments for AtoM.
-
-* :ref:`dev-env-vagrant`
-* :ref:`dev-env-compose`
-
-.. _dev-api-home:
-
-API
----
-
-Overview of the application programming interface available in AtoM. Includes
-sample requests and responses for available endpoints.
-
-* :ref:`api-intro`
-* :ref:`api-browse-taxonomies`
-* :ref:`api-browse-io`
-* :ref:`api-read-io`
-* :ref:`api-download-do`
+.. toctree::
+    :glob:
+
+    admin-manual/*
+    user-manual/*
+    dev-manual/*