From 35e7ace1182386413f4ac16236128f2e0f611a9f Mon Sep 17 00:00:00 2001 From: Adam Cox Date: Fri, 20 Jan 2023 13:02:37 -0600 Subject: [PATCH] initial implementation of pydata theme #274 --- README.md | 4 +- .../add-function.txt} | 0 .../arches-collector-checklist.txt | 2 +- .../arches-collector-manager.txt | 4 +- .../using-arches-collector.txt | 34 +++++++------- .../designing-the-database.txt | 18 ++++---- docs/administering/index.rst | 19 ++++++++ .../managing-map-layers.txt | 0 .../managing-permissions.txt | 4 +- .../ontologies-in-arches.txt | 0 docs/{ => administering}/rdm.txt | 4 +- docs/{ => administering}/spatial-views.rst | 0 .../two-factor-authentication.rst | 10 ++-- docs/conf.py | 46 +++++++++++++++---- .../arches-system-settings.txt | 2 +- .../define-resource-descriptors.rst | 0 docs/configuring/index.rst | 15 ++++++ .../settings-beyond-the-ui.txt | 0 .../{ => deployment}/arches-in-production.txt | 0 .../backing-up-the-database.txt | 0 docs/{ => deployment}/implementing-ssl.txt | 2 +- docs/deployment/index.rst | 19 ++++++++ .../migrating-a-local-app-to-aws-ec2.txt | 4 +- .../serving-arches-with-apache.txt | 0 .../setting-up-supervisord-for-celery.txt | 0 docs/{ => deployment}/using-aws-s3.txt | 0 docs/{ => developing}/accessibility.txt | 0 docs/{ => developing}/api.txt | 0 .../arches-and-elasticsearch.txt | 0 .../command-line-reference.txt | 0 .../creating-a-development-environment.txt | 0 docs/{ => developing}/data-model.txt | 44 +++++++++--------- docs/{ => developing}/import-export.txt | 4 +- docs/developing/index.rst | 30 ++++++++++++ .../integrating-arches-with-arcgis.txt | 0 docs/{ => developing}/localizing-arches.txt | 0 .../managing-and-hosting-iiif.txt | 0 .../migrating-from-v3}/exporting-v3-data.txt | 0 .../migrating-from-v3/index.rst} | 2 +- .../migrating-from-v3}/migrate-hip-app.txt | 0 .../migrating-from-v3}/migrate-other-app.txt | 2 +- docs/{ => developing}/task-management.txt | 0 .../{ => developing}/using-arches-offline.txt | 0 .../create-html-export-templates.txt | 0 docs/{ => extending}/creating-extensions.rst | 2 +- .../creating-new-map-layers.txt | 0 .../extensions/card-components.rst | 6 +-- docs/{ => extending}/extensions/datatypes.rst | 16 +++---- docs/{ => extending}/extensions/functions.rst | 0 docs/{ => extending}/extensions/plugins.rst | 2 +- .../extensions/resource-reports.rst | 0 .../extensions/search-filters.rst | 0 docs/{ => extending}/extensions/widgets.rst | 6 +-- docs/{ => extending}/extensions/workflows.rst | 10 ++-- docs/extending/index.rst | 15 ++++++ docs/{index.txt => index.bak} | 0 docs/index.rst | 35 ++++++++++++++ docs/installing/index.rst | 15 ++++++ docs/{ => installing}/installation.txt | 2 +- .../projects-and-packages.txt | 0 .../requirements-and-dependencies.txt | 0 docs/introduction/index.rst | 14 ++++++ docs/{ => introduction}/overview.txt | 0 docs/{ => introduction}/release-process.txt | 0 docs/{ => user-guide}/creating-resources.txt | 18 ++++---- docs/{ => user-guide}/deleting-resources.txt | 0 docs/user-guide/index.rst | 15 ++++++ docs/{ => user-guide}/searching.txt | 0 requirements.txt | 7 +-- 69 files changed, 316 insertions(+), 116 deletions(-) rename docs/{add-function.old => _deprecated/add-function.txt} (100%) rename docs/{ => _deprecated}/arches-collector-checklist.txt (98%) rename docs/{ => _deprecated}/arches-collector-manager.txt (97%) rename docs/{ => _deprecated}/using-arches-collector.txt (90%) rename docs/{ => administering}/designing-the-database.txt (96%) create mode 100644 docs/administering/index.rst rename docs/{ => administering}/managing-map-layers.txt (100%) rename docs/{ => administering}/managing-permissions.txt (96%) rename docs/{ => administering}/ontologies-in-arches.txt (100%) rename docs/{ => administering}/rdm.txt (99%) rename docs/{ => administering}/spatial-views.rst (100%) rename docs/{ => administering}/two-factor-authentication.rst (93%) rename docs/{ => configuring}/arches-system-settings.txt (99%) rename docs/{ => configuring}/define-resource-descriptors.rst (100%) create mode 100644 docs/configuring/index.rst rename docs/{ => configuring}/settings-beyond-the-ui.txt (100%) rename docs/{ => deployment}/arches-in-production.txt (100%) rename docs/{ => deployment}/backing-up-the-database.txt (100%) rename docs/{ => deployment}/implementing-ssl.txt (99%) create mode 100644 docs/deployment/index.rst rename docs/{ => deployment}/migrating-a-local-app-to-aws-ec2.txt (99%) rename docs/{ => deployment}/serving-arches-with-apache.txt (100%) rename docs/{ => deployment}/setting-up-supervisord-for-celery.txt (100%) rename docs/{ => deployment}/using-aws-s3.txt (100%) rename docs/{ => developing}/accessibility.txt (100%) rename docs/{ => developing}/api.txt (100%) rename docs/{ => developing}/arches-and-elasticsearch.txt (100%) rename docs/{ => developing}/command-line-reference.txt (100%) rename docs/{ => developing}/creating-a-development-environment.txt (100%) rename docs/{ => developing}/data-model.txt (91%) rename docs/{ => developing}/import-export.txt (99%) create mode 100644 docs/developing/index.rst rename docs/{ => developing}/integrating-arches-with-arcgis.txt (100%) rename docs/{ => developing}/localizing-arches.txt (100%) rename docs/{ => developing}/managing-and-hosting-iiif.txt (100%) rename docs/{ => developing/migrating-from-v3}/exporting-v3-data.txt (100%) rename docs/{v3-migration.txt => developing/migrating-from-v3/index.rst} (97%) rename docs/{ => developing/migrating-from-v3}/migrate-hip-app.txt (100%) rename docs/{ => developing/migrating-from-v3}/migrate-other-app.txt (99%) rename docs/{ => developing}/task-management.txt (100%) rename docs/{ => developing}/using-arches-offline.txt (100%) rename docs/{ => extending}/create-html-export-templates.txt (100%) rename docs/{ => extending}/creating-extensions.rst (99%) rename docs/{ => extending}/creating-new-map-layers.txt (100%) rename docs/{ => extending}/extensions/card-components.rst (95%) rename docs/{ => extending}/extensions/datatypes.rst (95%) rename docs/{ => extending}/extensions/functions.rst (100%) rename docs/{ => extending}/extensions/plugins.rst (97%) rename docs/{ => extending}/extensions/resource-reports.rst (100%) rename docs/{ => extending}/extensions/search-filters.rst (100%) rename docs/{ => extending}/extensions/widgets.rst (95%) rename docs/{ => extending}/extensions/workflows.rst (97%) create mode 100644 docs/extending/index.rst rename docs/{index.txt => index.bak} (100%) create mode 100644 docs/index.rst create mode 100644 docs/installing/index.rst rename docs/{ => installing}/installation.txt (99%) rename docs/{ => installing}/projects-and-packages.txt (100%) rename docs/{ => installing}/requirements-and-dependencies.txt (100%) create mode 100644 docs/introduction/index.rst rename docs/{ => introduction}/overview.txt (100%) rename docs/{ => introduction}/release-process.txt (100%) rename docs/{ => user-guide}/creating-resources.txt (89%) rename docs/{ => user-guide}/deleting-resources.txt (100%) create mode 100644 docs/user-guide/index.rst rename docs/{ => user-guide}/searching.txt (100%) diff --git a/README.md b/README.md index 3ce7488d..d59f5150 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ Given that there is a header (of any level) somewhere in the documentation that If you want an image that is a hyperlink to the file itself, use a `figure` instead of an image. The figure is automatically turned into a link, **but only if a height or width attribute is set**. - .. figure:: images/datamodel-arches-4.4.1-032119.svg + .. figure:: ../images/datamodel-arches-4.4.1-032119.svg :width: 100% :align: center @@ -135,7 +135,7 @@ If you want an image that is a hyperlink to the file itself, use a `figure` inst Previously we had used - .. image:: images/datamodel-full-4.4.1-032119.svg + .. image:: ../images/datamodel-full-4.4.1-032119.svg target: /_images/datamodel-full-4.4.1-032119.svg and while this works on a local build, it does not work when published in RTD (https://github.com/archesproject/arches-docs/issues/120). diff --git a/docs/add-function.old b/docs/_deprecated/add-function.txt similarity index 100% rename from docs/add-function.old rename to docs/_deprecated/add-function.txt diff --git a/docs/arches-collector-checklist.txt b/docs/_deprecated/arches-collector-checklist.txt similarity index 98% rename from docs/arches-collector-checklist.txt rename to docs/_deprecated/arches-collector-checklist.txt index 348d282f..309ac5cc 100644 --- a/docs/arches-collector-checklist.txt +++ b/docs/_deprecated/arches-collector-checklist.txt @@ -78,7 +78,7 @@ To allow others to connect to your Arches instance, including Arches Collector u #. Create a new application #. Fill out the form with a **Name** of your choosing, and set **Client type** and **Authorization grant type** as shown in the image below. - .. image:: images/oauth-create-client.png + .. image:: ../images/oauth-create-client.png #. Copy the **Client id** and submit the form (you can access this id at any time). #. In your Arches project's ``settings.py`` or ``settings_local.py`` file, set or add this variable diff --git a/docs/arches-collector-manager.txt b/docs/_deprecated/arches-collector-manager.txt similarity index 97% rename from docs/arches-collector-manager.txt rename to docs/_deprecated/arches-collector-manager.txt index 4e8edb23..fe4f9fb1 100644 --- a/docs/arches-collector-manager.txt +++ b/docs/_deprecated/arches-collector-manager.txt @@ -53,7 +53,7 @@ page: Now, using the navigation tree in the left-hand panel, you will set all of your project parameters. Detailed information about each parameter is available in the in-app help: -.. image:: images/open-help-project.gif +.. image:: ../images/open-help-project.gif When you have filled out all the parameters, you will see in the project summary that all Project Requirements have been met. You are now ready to activate the Project. @@ -63,7 +63,7 @@ Requirements have been met. You are now ready to activate the Project. database, and they cannot be changed. Therefore, it's wise to double-check everything before the initial activation. -.. image:: images/activate-mobile-project.gif +.. image:: ../images/activate-mobile-project.gif Great! Now that you have activated your project, any data collection user that you assigned to it will be able to download it through the Arches Collector app and begin collecting data. diff --git a/docs/using-arches-collector.txt b/docs/_deprecated/using-arches-collector.txt similarity index 90% rename from docs/using-arches-collector.txt rename to docs/_deprecated/using-arches-collector.txt index 9df0d16d..42e64816 100644 --- a/docs/using-arches-collector.txt +++ b/docs/_deprecated/using-arches-collector.txt @@ -2,11 +2,11 @@ Introduction to Arches Collector ################################ -.. image:: images/arches-mobile/apple-app-store.png +.. image:: ../images/arches-mobile/apple-app-store.png :height: 50px :target: https://apps.apple.com/us/app/arches-collector/id1377842164 -.. image:: images/arches-mobile/google-play-badge.png +.. image:: ../images/arches-mobile/google-play-badge.png :height: 50px :target: https://play.google.com/store/apps/details?id=org.archesproject.archescollector @@ -55,7 +55,7 @@ Download a Project Upon entering an Arches instance, you will see a list of projects. These are all of the mobile data collection projects to which you have been granted access. Choose a one, and download it to begin working. -.. figure:: images/arches-mobile/all-projects-in-instance.png +.. figure:: ../images/arches-mobile/all-projects-in-instance.png :height: 400px :align: center @@ -78,7 +78,7 @@ In some cases, you may expect to collect data outside of wifi/cellular network r From the list of projects, open the settings menu for a project and flip the "Use offline maps" switch. -.. figure:: images/arches-mobile/activate-offline-map.png +.. figure:: ../images/arches-mobile/activate-offline-map.png :height: 400px :align: center @@ -94,7 +94,7 @@ There are four main screens within a project, and you can switch between them by **NEW** - Choose a resource model to create a new resource. -.. figure:: images/arches-mobile/new-resource-tab.png +.. figure:: ../images/arches-mobile/new-resource-tab.png :height: 400px :align: center @@ -108,7 +108,7 @@ From here you will create new resources. + Existing Resources that were downloaded as part of the project + New resources created and synced by other members of this project (you must sync your own project to get these resources) -.. figure:: images/arches-mobile/resources-review.png +.. figure:: ../images/arches-mobile/resources-review.png :height: 400px :align: center @@ -118,7 +118,7 @@ From here you can select a resource to edit or view its report. **MAP** - A map view showing all of the resources in your project that have location data. The basemap is defined in the project configuration. See :ref:`Download the Offline Map` if you expect to be collecting data beyond wifi/cellular network range. -.. figure:: images/arches-mobile/map.png +.. figure:: ../images/arches-mobile/map.png :height: 400px :align: center @@ -128,7 +128,7 @@ From here you can select a resource to edit. **SUMMARY** - A project-level summary. -.. figure:: images/arches-mobile/project-summary.png +.. figure:: ../images/arches-mobile/project-summary.png :height: 400px :align: center @@ -137,25 +137,25 @@ Creating Records New resources are made from the **NEW** screen, where you will choose a resource model to use for the new resource. In the following example, a new "Heritage Asset - Monument" resource will be created. -.. figure:: images/arches-mobile/new-resource-tab.png +.. figure:: ../images/arches-mobile/new-resource-tab.png :height: 400px :align: center Beginning to create a new resource, you'll see all of the cards (or "records") that can be added to the resource. -.. figure:: images/arches-mobile/new-resource-set1.png +.. figure:: ../images/arches-mobile/new-resource-set1.png :height: 400px :align: center In the images above, the "Monument Asset Name" card is selected in order to create a new name for the resource. -.. figure:: images/arches-mobile/add-resource-name-2.png +.. figure:: ../images/arches-mobile/add-resource-name-2.png :height: 400px :align: center An Asset Name and Name Type are entered. Because all changes are automatically saved, the display name is updated as soon as this name is entered. Note that this happens because the Define Resource Descriptors function has been properly configured in the Resource Model by the database administrator. -.. figure:: images/arches-mobile/new-resource-set2.png +.. figure:: ../images/arches-mobile/new-resource-set2.png :height: 400px :align: center @@ -165,7 +165,7 @@ Beginning to create a new resource, you'll see all of the cards (or "records") t While the example above shows text and dropdown entries, other types of data will have different input methods. -.. figure:: images/arches-mobile/add-resource-location.png +.. figure:: ../images/arches-mobile/add-resource-location.png :height: 400px :align: center @@ -176,7 +176,7 @@ Editing Records From the **REVIEW** screen of a project, you can select resources to edit them. In this example "The Eliza Jane" will be selected. -.. figure:: images/arches-mobile/resources-review.png +.. figure:: ../images/arches-mobile/resources-review.png :height: 400px :align: center @@ -184,7 +184,7 @@ From the **REVIEW** screen of a project, you can select resources to edit them. When you've selected a resource you'll be brought to its RESOURCE REPORT: a summary of all the records that have been added to it. As shown below, you can edit any existing record (as long as you have the proper permissions). -.. figure:: images/arches-mobile/resource-edit-measurement.png +.. figure:: ../images/arches-mobile/resource-edit-measurement.png :height: 400px :align: center @@ -211,7 +211,7 @@ Additionally, some changes occur to the resources you have created in your proje You can sync a project from within the project itself: -.. figure:: images/arches-mobile/project-menu-edit.png +.. figure:: ../images/arches-mobile/project-menu-edit.png :height: 350px :align: center @@ -219,7 +219,7 @@ You can sync a project from within the project itself: Or you can sync from the main project list page: -.. figure:: images/arches-mobile/sync-from-project-list.png +.. figure:: ../images/arches-mobile/sync-from-project-list.png :height: 350px :align: center diff --git a/docs/designing-the-database.txt b/docs/administering/designing-the-database.txt similarity index 96% rename from docs/designing-the-database.txt rename to docs/administering/designing-the-database.txt index 614bdea8..6218706e 100644 --- a/docs/designing-the-database.txt +++ b/docs/administering/designing-the-database.txt @@ -24,13 +24,13 @@ Arches Designer The Arches Designer is where you export, import, duplicate, modify, and create your Resource Models and Branches. Any user who is part of the Graph Editor group will have access to the Arches Designer. -.. image:: images/arches-desinger.png +.. image:: ../images/arches-desinger.png If you don't see any Resource Models listed in your Arches Designer, you may want to consider :ref:`loading a package `. Alternatively, you can directly import individual Resource Model files through **Add ...**. To edit a Resource Model, click on it or click **Manage ...** > **Manage Graph** and you'll be brought to the Graph Designer. -.. image:: images/select-graph.png +.. image:: ../images/select-graph.png Graph Designer ============== @@ -44,7 +44,7 @@ Graph Tab The Graph Tab is where you build the actual graph, a structured set of nodes and nodegroups, which is the core of a Resource Model or Branch. As noted above, sometimes Resource Models and Branches are generically referred to as "graphs", and this may seem confusing at first, but you'll come to see that it is an appropriate nickname. -.. figure:: images/graph-designer-graph-tab.png +.. figure:: ../images/graph-designer-graph-tab.png Screenshot of the Graph Tab in the Graph Designer, showing an "Actor" Resource Model. @@ -56,7 +56,7 @@ During the graph construction process, you are able to create a new Branch from Along the way, you can use the preview button to display the graph in a more graph-like manner. This view will be familiar to users of Arches going back to version 3.0. -.. figure:: images/graph-designer-graph-tab-preview.png +.. figure:: ../images/graph-designer-graph-tab-preview.png Screenshot of the Graph Tab in the Graph Designer, showing the graph in preview mode. @@ -88,7 +88,7 @@ Cards Tab Once you have added nodes to the graph, you can switch to the Cards Tab to begin refining the user interface. As you can see, the graph tree is replaced with a "card tree", which is very similar to what users will see when they begin creating a resource using this Resource Model. -.. figure:: images/graph-designer-card-tab.png +.. figure:: ../images/graph-designer-card-tab.png Screenshot of the Cards Tab in the Graph Designer, showing an "Actor" Resource Model. @@ -103,7 +103,7 @@ Card Type The UI of a card can be configured using a card component. Note that when you click a node in the card tree, the "Card Configuration" panel on the right-hand side of the screen will show the card component in a dropdown called "Card Type". -.. figure:: images/card_component.png +.. figure:: ../images/card_component.png Screenshot of the card manager user interface, highlighting "Card Type" dropdown in the top-right corner. @@ -123,7 +123,7 @@ The **Map Card** enables more customization for nodes of type ``geojson-collecti or `source_layer `_ simply type its name (no quotes). -.. figure:: images/mapcard.png +.. figure:: ../images/mapcard.png :width: 250 Screenshot of card configuration panel, highlighting the fields: "Select drawings map source" and "Select drawings map source layer". @@ -133,7 +133,7 @@ Related Resources Map Card ^^^^^^^^^^^^^^^^^^^^^^^^^^ The **Related Resources Map Card** enables a more rich user experience for nodes of type ``related-resource``. Like the Map Card, map layer data representing resources can be added to a map UI such that the user can navigate geographically to select a related resource instead of paging through the dropdown list of relatable resources (however the dropdown still works normally in this card component). This card component is very useful if a user knows the geographic context of a resource (like what neighborhood it's in) instead of its name. The steps to add such map data are the same as in the Map Card configuration panel. -.. figure:: images/related_resources_mapcard.png +.. figure:: ../images/related_resources_mapcard.png Screenshot of a card using related resources map card, showing a selected resource in the map, polygon outlined in purple to show selection, and the resource instance's name selected in the dropdown widget to the right of the map. @@ -143,7 +143,7 @@ Permissions Tab Arches allows you to define permissions at the card level, so in the Permissions Tab you'll see the card tree, just as in the Cards tab. However, you will only be able to select entire cards, not individual nodes. -.. figure:: images/graph-designer-permissions-tab.png +.. figure:: ../images/graph-designer-permissions-tab.png Screenshot of the Permissions Tab in the Graph Designer, showing an "Actor" Resource Model. diff --git a/docs/administering/index.rst b/docs/administering/index.rst new file mode 100644 index 00000000..a5d78651 --- /dev/null +++ b/docs/administering/index.rst @@ -0,0 +1,19 @@ +============= +Administering +============= + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: Administering + :maxdepth: 2 + + designing-the-database + ontologies-in-arches + managing-map-layers + rdm + managing-permissions + two-factor-authentication + spatial-views diff --git a/docs/managing-map-layers.txt b/docs/administering/managing-map-layers.txt similarity index 100% rename from docs/managing-map-layers.txt rename to docs/administering/managing-map-layers.txt diff --git a/docs/managing-permissions.txt b/docs/administering/managing-permissions.txt similarity index 96% rename from docs/managing-permissions.txt rename to docs/administering/managing-permissions.txt index ab745bd9..f342d3da 100644 --- a/docs/managing-permissions.txt +++ b/docs/administering/managing-permissions.txt @@ -32,7 +32,7 @@ This level of access is handled by adding Users to certain Groups through the Dj Once logged into the admin panel, you'll see this at the top of the page: -.. figure:: images/django-admin1.png +.. figure:: ../images/django-admin1.png :width: 100% :align: center @@ -41,7 +41,7 @@ Once logged into the admin panel, you'll see this at the top of the page: Click **Users** to see a list of all your Arches users. Selecting a user will yield a generic profile page like this: -.. figure:: images/django-admin2.png +.. figure:: ../images/django-admin2.png :width: 100% :align: center diff --git a/docs/ontologies-in-arches.txt b/docs/administering/ontologies-in-arches.txt similarity index 100% rename from docs/ontologies-in-arches.txt rename to docs/administering/ontologies-in-arches.txt diff --git a/docs/rdm.txt b/docs/administering/rdm.txt similarity index 99% rename from docs/rdm.txt rename to docs/administering/rdm.txt index 7e867f12..53b20af7 100644 --- a/docs/rdm.txt +++ b/docs/administering/rdm.txt @@ -51,7 +51,7 @@ In this section you will learn about: - Deleting a scheme -.. image:: images/ArchesRDM.jpg +.. image:: ../images/ArchesRDM.jpg **Adding a new concept scheme** ``````````````````````````````` @@ -361,7 +361,7 @@ Method 2: Graph view increased by 1 and the imported concept scheme will appear in the **ConceptSchemes** panel. -.. image:: images/ImportConceptScheme.jpg +.. image:: ../images/ImportConceptScheme.jpg diff --git a/docs/spatial-views.rst b/docs/administering/spatial-views.rst similarity index 100% rename from docs/spatial-views.rst rename to docs/administering/spatial-views.rst diff --git a/docs/two-factor-authentication.rst b/docs/administering/two-factor-authentication.rst similarity index 93% rename from docs/two-factor-authentication.rst rename to docs/administering/two-factor-authentication.rst index 8b79d19f..fd5134f8 100644 --- a/docs/two-factor-authentication.rst +++ b/docs/administering/two-factor-authentication.rst @@ -47,7 +47,7 @@ Setting up Two-factor Authentication for User Accounts If ``ENABLE_TWO_FACTOR_AUTHENTICATION`` or ``FORCE_TWO_FACTOR_AUTHENTICATION`` have been enabled in your Arches application, users can check the status of their accounts in the User Profile page. -.. figure:: images/two-factor-authentication-user-profile.png +.. figure:: ../images/two-factor-authentication-user-profile.png :width: 100% :align: center @@ -55,7 +55,7 @@ If ``ENABLE_TWO_FACTOR_AUTHENTICATION`` or ``FORCE_TWO_FACTOR_AUTHENTICATION`` h From User Profile Edit page, Users can send an email to their registered email address containing instructions and a link to set up two-factor authentication. -.. figure:: images/two-factor-authentication-send-email-from-profile.png +.. figure:: ../images/two-factor-authentication-send-email-from-profile.png :width: 100% :align: center @@ -68,7 +68,7 @@ From User Profile Edit page, Users can send an email to their registered email a Following the email link, the user will navigate to the two-factor authentication settings page. -.. figure:: images/two-factor-authentication-settings.png +.. figure:: ../images/two-factor-authentication-settings.png :width: 100% :align: center @@ -76,7 +76,7 @@ Following the email link, the user will navigate to the two-factor authenticatio From this page, Users can generate a QR code to be scanned with an external authentication application, or a secret key to be entered manually. This secret is used to generate time-based authentication tokens. -.. figure:: images/two-factor-authentication-qr-code.png +.. figure:: ../images/two-factor-authentication-qr-code.png :width: 100% :align: center @@ -84,7 +84,7 @@ From this page, Users can generate a QR code to be scanned with an external auth Once the user has enabled two-factor authentication, or if ``FORCE_TWO_FACTOR_AUTHENTICATION`` has been enabled at the system level, the user will be presented with an additional step in the login process. Once the six-digit authentication code has been entered, the User will be logged in. -.. figure:: images/two-factor-authentication-login.png +.. figure:: ../images/two-factor-authentication-login.png :width: 100% :align: center diff --git a/docs/conf.py b/docs/conf.py index aefda663..7cefb4ac 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,7 +72,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -82,7 +82,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ['_build', "_deprecated"] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -116,12 +116,38 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# html_theme = 'default' +html_theme = "pydata_sphinx_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + "github_url": "https://github.com/archesproject/arches-docs", + "header_links_before_dropdown": 3, + "show_toc_level": 1, +# "navbar_center": ["version-switcher", "section1"], + "icon_links": [ + { + "name": "Arches Community Forum", + "url": "https://community.archesproject.org", + # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local") + "icon": "fa-solid fa-users", + "type": "fontawesome", + }, + { + "name": "Arches Project Home", + "url": "https://archesproject.org", + # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local") + "icon": "fa-solid fa-home", + "type": "fontawesome", + } + ], + "logo": { + "text": "", + "image_dark": "images/Arches-Logo_TM.png", + "alt_text": "Arches Documentation", + }, +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] @@ -129,12 +155,12 @@ # USING THIS THEME LOCALLY # https://github.com/snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +# on_rtd = os.environ.get('READTHEDOCS', None) == 'True' -if not on_rtd: - import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +# if not on_rtd: +# import sphinx_rtd_theme +# html_theme = 'sphinx_rtd_theme' +# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -207,7 +233,7 @@ # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' +html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value diff --git a/docs/arches-system-settings.txt b/docs/configuring/arches-system-settings.txt similarity index 99% rename from docs/arches-system-settings.txt rename to docs/configuring/arches-system-settings.txt index 96f640c8..c764cc17 100644 --- a/docs/arches-system-settings.txt +++ b/docs/configuring/arches-system-settings.txt @@ -92,4 +92,4 @@ The first item of business when preparing your production of Arches is to change 2. Navigate to the Django admin user page ``http://localhost:8000/admin/auth/user/``. 3. In the upper right of the page select ``CHANGE PASSWORD`` and follow the steps to update the password. -.. image:: images/change-admin-pwd.png +.. image:: ../images/change-admin-pwd.png diff --git a/docs/define-resource-descriptors.rst b/docs/configuring/define-resource-descriptors.rst similarity index 100% rename from docs/define-resource-descriptors.rst rename to docs/configuring/define-resource-descriptors.rst diff --git a/docs/configuring/index.rst b/docs/configuring/index.rst new file mode 100644 index 00000000..ca404373 --- /dev/null +++ b/docs/configuring/index.rst @@ -0,0 +1,15 @@ +============ +Configuring +============ + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: Configuring + :maxdepth: 1 + + define-resource-descriptors + arches-system-settings + settings-beyond-the-ui diff --git a/docs/settings-beyond-the-ui.txt b/docs/configuring/settings-beyond-the-ui.txt similarity index 100% rename from docs/settings-beyond-the-ui.txt rename to docs/configuring/settings-beyond-the-ui.txt diff --git a/docs/arches-in-production.txt b/docs/deployment/arches-in-production.txt similarity index 100% rename from docs/arches-in-production.txt rename to docs/deployment/arches-in-production.txt diff --git a/docs/backing-up-the-database.txt b/docs/deployment/backing-up-the-database.txt similarity index 100% rename from docs/backing-up-the-database.txt rename to docs/deployment/backing-up-the-database.txt diff --git a/docs/implementing-ssl.txt b/docs/deployment/implementing-ssl.txt similarity index 99% rename from docs/implementing-ssl.txt rename to docs/deployment/implementing-ssl.txt index 8e19106d..d5472dbe 100644 --- a/docs/implementing-ssl.txt +++ b/docs/deployment/implementing-ssl.txt @@ -22,7 +22,7 @@ A good guide about how to implement this using OpenSSL on Ubuntu 20.04 can be fo .. note:: This option allows you to implement SSL using your server's IP address without a domain name. However, when accessing the website using any modern browser the connection will be marked as not private. -.. image :: images/connection-not-private.png +.. image :: ../images/connection-not-private.png :target: _images/connection-not-private.png Signed by Let's encrypt diff --git a/docs/deployment/index.rst b/docs/deployment/index.rst new file mode 100644 index 00000000..21c57b10 --- /dev/null +++ b/docs/deployment/index.rst @@ -0,0 +1,19 @@ +============ +Deployment +============ + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: Running Arches in Production + :maxdepth: 2 + + arches-in-production + serving-arches-with-apache + implementing-ssl + setting-up-supervisord-for-celery + backing-up-the-database + using-aws-s3 + migrating-a-local-app-to-aws-ec2 diff --git a/docs/migrating-a-local-app-to-aws-ec2.txt b/docs/deployment/migrating-a-local-app-to-aws-ec2.txt similarity index 99% rename from docs/migrating-a-local-app-to-aws-ec2.txt rename to docs/deployment/migrating-a-local-app-to-aws-ec2.txt index 89bc628b..3000354a 100644 --- a/docs/migrating-a-local-app-to-aws-ec2.txt +++ b/docs/deployment/migrating-a-local-app-to-aws-ec2.txt @@ -32,7 +32,7 @@ Create an EC2 Instance From your AWS account console, navigate to the EC2 section. You should get to a screen that looks something like this: -.. figure:: images/ec2-dash.png +.. figure:: ../images/ec2-dash.png :width: 100% :align: center @@ -86,7 +86,7 @@ Now go back to AWS, and look at the status of your server instance. By now, it p 4. Click OK to trust the certificate, and login to your server as the AWS default user `ubuntu`. 5. If everything goes well you should be greeted with a screen like this: -.. figure:: images/ubuntu-welcome.png +.. figure:: ../images/ubuntu-welcome.png :width: 100% :align: center diff --git a/docs/serving-arches-with-apache.txt b/docs/deployment/serving-arches-with-apache.txt similarity index 100% rename from docs/serving-arches-with-apache.txt rename to docs/deployment/serving-arches-with-apache.txt diff --git a/docs/setting-up-supervisord-for-celery.txt b/docs/deployment/setting-up-supervisord-for-celery.txt similarity index 100% rename from docs/setting-up-supervisord-for-celery.txt rename to docs/deployment/setting-up-supervisord-for-celery.txt diff --git a/docs/using-aws-s3.txt b/docs/deployment/using-aws-s3.txt similarity index 100% rename from docs/using-aws-s3.txt rename to docs/deployment/using-aws-s3.txt diff --git a/docs/accessibility.txt b/docs/developing/accessibility.txt similarity index 100% rename from docs/accessibility.txt rename to docs/developing/accessibility.txt diff --git a/docs/api.txt b/docs/developing/api.txt similarity index 100% rename from docs/api.txt rename to docs/developing/api.txt diff --git a/docs/arches-and-elasticsearch.txt b/docs/developing/arches-and-elasticsearch.txt similarity index 100% rename from docs/arches-and-elasticsearch.txt rename to docs/developing/arches-and-elasticsearch.txt diff --git a/docs/command-line-reference.txt b/docs/developing/command-line-reference.txt similarity index 100% rename from docs/command-line-reference.txt rename to docs/developing/command-line-reference.txt diff --git a/docs/creating-a-development-environment.txt b/docs/developing/creating-a-development-environment.txt similarity index 100% rename from docs/creating-a-development-environment.txt rename to docs/developing/creating-a-development-environment.txt diff --git a/docs/data-model.txt b/docs/developing/data-model.txt similarity index 91% rename from docs/data-model.txt rename to docs/developing/data-model.txt index e47e7808..8dfb5051 100644 --- a/docs/data-model.txt +++ b/docs/developing/data-model.txt @@ -2,13 +2,13 @@ Data Model ########## -.. figure:: images/arches-data-model-2022-04-18.png +.. figure:: ../images/arches-data-model-2022-04-18.png :width: 100% :align: center Arches data model. -.. figure:: images/full-data-model-2022-04-18.png +.. figure:: ../images/full-data-model-2022-04-18.png :width: 100% :align: center @@ -37,7 +37,7 @@ elements in Arches: The relationships among these components and their dependencies are visualized below: -.. image :: images/resource-model.png +.. image :: ../images/resource-model.png :target: _images/resource-model.png The Arches logical model has been developed to support this modular @@ -131,33 +131,33 @@ see :ref:`here `. GraphModel ========== -.. literalinclude:: examples/arches/graphmodel.py +.. literalinclude:: ../examples/arches/graphmodel.py :language: python Node ==== -.. literalinclude:: examples/arches/node.py +.. literalinclude:: ../examples/arches/node.py :language: python NodeGroup ========= -.. literalinclude:: examples/arches/nodegroup.py +.. literalinclude:: ../examples/arches/nodegroup.py :language: python Edge ==== -.. literalinclude:: examples/arches/edge.py +.. literalinclude:: ../examples/arches/edge.py :language: python Function ======== -.. literalinclude:: examples/arches/function.py +.. literalinclude:: ../examples/arches/function.py :language: python @@ -219,14 +219,14 @@ new ontology. Ontology ======== -.. literalinclude:: examples/arches/ontology.py +.. literalinclude:: ../examples/arches/ontology.py :language: python OntologyClass ============= -.. literalinclude:: examples/arches/ontologyclass.py +.. literalinclude:: ../examples/arches/ontologyclass.py :language: python ********** @@ -252,20 +252,20 @@ as `Relation`_ instances. Concept ======= -.. literalinclude:: examples/arches/concept.py +.. literalinclude:: ../examples/arches/concept.py :language: python Relation ======== -.. literalinclude:: examples/arches/relation.py +.. literalinclude:: ../examples/arches/relation.py :language: python Value ===== -.. literalinclude:: examples/arches/value.py +.. literalinclude:: ../examples/arches/value.py :language: python ************* @@ -331,21 +331,21 @@ instances. ResourceInstance ================ -.. literalinclude:: examples/arches/resourceinstance.py +.. literalinclude:: ../examples/arches/resourceinstance.py :language: python TileModel ========= -.. literalinclude:: examples/arches/tilemodel.py +.. literalinclude:: ../examples/arches/tilemodel.py :language: python ResourceXResource ================= -.. literalinclude:: examples/arches/resourcexresource.py +.. literalinclude:: ../examples/arches/resourcexresource.py :language: python @@ -355,7 +355,7 @@ Edit Log A change in a Tile's contents, which is the result of any resource edits, is recorded as an instance of the EditLog model. -.. literalinclude:: examples/arches/editlog.py +.. literalinclude:: ../examples/arches/editlog.py :language: python ******************* @@ -378,7 +378,7 @@ resource instances. Generally, the process works like this: in the Arches UI. -.. image:: images/graph-cards.png +.. image:: ../images/graph-cards.png :target: _images/graph-cards.png @@ -402,7 +402,7 @@ both read-only and data entry contexts. CardModel ========= -.. literalinclude:: examples/arches/cardmodel.py +.. literalinclude:: ../examples/arches/cardmodel.py :language: python @@ -411,7 +411,7 @@ Card Component A Card Component renders a Card. -.. literalinclude:: examples/arches/cardcomponent.py +.. literalinclude:: ../examples/arches/cardcomponent.py :language: python Field description: @@ -425,7 +425,7 @@ Field description: Widget ====== -.. literalinclude:: examples/arches/widget.py +.. literalinclude:: ../examples/arches/widget.py :language: python @@ -433,5 +433,5 @@ DDataType ========= Used to validate data entered into ``widgets`` -.. literalinclude:: examples/arches/ddatatype.py +.. literalinclude:: ../examples/arches/ddatatype.py :language: python diff --git a/docs/import-export.txt b/docs/developing/import-export.txt similarity index 99% rename from docs/import-export.txt rename to docs/developing/import-export.txt index d67363a9..f5c9c95b 100644 --- a/docs/import-export.txt +++ b/docs/developing/import-export.txt @@ -1,4 +1,4 @@ -====================== +====================== Resource Import/Export ====================== @@ -304,7 +304,7 @@ All CSV files must be accompanied by a **mapping file**. This is a JSON-structur To create a mapping file for a Resource Model in your database, go to the Arches Designer landing page. Find the Resource Model into which you plan to load resources, and choose Export Mapping File from the Manage menu. -.. image:: images/create_mapping_file.gif +.. image:: ../images/create_mapping_file.gif Unzip the download, and you'll find a ``.mapping`` file as well as a ``_concepts.json`` file (see `Concepts File`_). The contents of the mapping file will look something like this:: diff --git a/docs/developing/index.rst b/docs/developing/index.rst new file mode 100644 index 00000000..b7b09258 --- /dev/null +++ b/docs/developing/index.rst @@ -0,0 +1,30 @@ +========== +Developing +========== + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: For Developers + :maxdepth: 2 + + accessibility + arches-and-elasticsearch + api + command-line-reference + creating-a-development-environment + data-model + integrating-arches-with-arcgis + localizing-arches + managing-and-hosting-iiif + import-export + task-management + using-arches-offline + +.. toctree:: + :caption: Migration from v3 + :maxdepth: 2 + + migrating-from-v3/index diff --git a/docs/integrating-arches-with-arcgis.txt b/docs/developing/integrating-arches-with-arcgis.txt similarity index 100% rename from docs/integrating-arches-with-arcgis.txt rename to docs/developing/integrating-arches-with-arcgis.txt diff --git a/docs/localizing-arches.txt b/docs/developing/localizing-arches.txt similarity index 100% rename from docs/localizing-arches.txt rename to docs/developing/localizing-arches.txt diff --git a/docs/managing-and-hosting-iiif.txt b/docs/developing/managing-and-hosting-iiif.txt similarity index 100% rename from docs/managing-and-hosting-iiif.txt rename to docs/developing/managing-and-hosting-iiif.txt diff --git a/docs/exporting-v3-data.txt b/docs/developing/migrating-from-v3/exporting-v3-data.txt similarity index 100% rename from docs/exporting-v3-data.txt rename to docs/developing/migrating-from-v3/exporting-v3-data.txt diff --git a/docs/v3-migration.txt b/docs/developing/migrating-from-v3/index.rst similarity index 97% rename from docs/v3-migration.txt rename to docs/developing/migrating-from-v3/index.rst index f61d5cf2..ebb1e4a0 100644 --- a/docs/v3-migration.txt +++ b/docs/developing/migrating-from-v3/index.rst @@ -14,7 +14,7 @@ Before migrating data, you'll need to :ref:`install core Arches `. + Please see the main :doc:`installation guide `. Before moving on, you must be able to run the Django development and view your project in a browser at ``http://localhost:8000``. diff --git a/docs/migrate-hip-app.txt b/docs/developing/migrating-from-v3/migrate-hip-app.txt similarity index 100% rename from docs/migrate-hip-app.txt rename to docs/developing/migrating-from-v3/migrate-hip-app.txt diff --git a/docs/migrate-other-app.txt b/docs/developing/migrating-from-v3/migrate-other-app.txt similarity index 99% rename from docs/migrate-other-app.txt rename to docs/developing/migrating-from-v3/migrate-other-app.txt index f1c22ddd..fecdfea1 100644 --- a/docs/migrate-other-app.txt +++ b/docs/developing/migrating-from-v3/migrate-other-app.txt @@ -207,5 +207,5 @@ using that workflow until you are finished with the migration.) See :ref:`Arches-HIP workflow Step 6 <6. Load the entire package.>`. -.. |help-btn| image:: images/in-app-help-icon.png +.. |help-btn| image:: ../../images/in-app-help-icon.png :align: middle diff --git a/docs/task-management.txt b/docs/developing/task-management.txt similarity index 100% rename from docs/task-management.txt rename to docs/developing/task-management.txt diff --git a/docs/using-arches-offline.txt b/docs/developing/using-arches-offline.txt similarity index 100% rename from docs/using-arches-offline.txt rename to docs/developing/using-arches-offline.txt diff --git a/docs/create-html-export-templates.txt b/docs/extending/create-html-export-templates.txt similarity index 100% rename from docs/create-html-export-templates.txt rename to docs/extending/create-html-export-templates.txt diff --git a/docs/creating-extensions.rst b/docs/extending/creating-extensions.rst similarity index 99% rename from docs/creating-extensions.rst rename to docs/extending/creating-extensions.rst index ba14dd76..d482d198 100644 --- a/docs/creating-extensions.rst +++ b/docs/extending/creating-extensions.rst @@ -130,7 +130,7 @@ Extension Data Models The backend models for each extension type are shown below. -.. figure:: images/extension-model-2022-04-18.png +.. figure:: ../images/extension-model-2022-04-18.png :width: 100% :align: center diff --git a/docs/creating-new-map-layers.txt b/docs/extending/creating-new-map-layers.txt similarity index 100% rename from docs/creating-new-map-layers.txt rename to docs/extending/creating-new-map-layers.txt diff --git a/docs/extensions/card-components.rst b/docs/extending/extensions/card-components.rst similarity index 95% rename from docs/extensions/card-components.rst rename to docs/extending/extensions/card-components.rst index a9c12684..6ba2e485 100644 --- a/docs/extensions/card-components.rst +++ b/docs/extending/extensions/card-components.rst @@ -47,13 +47,13 @@ information. Here's the template for the default Card Component: -.. literalinclude:: ../examples/default-card.htm +.. literalinclude:: ../../examples/default-card.htm :language: htmldjango And here's the Knockout file: -.. literalinclude:: ../examples/default-card.js +.. literalinclude:: ../../examples/default-card.js :language: javascript @@ -65,7 +65,7 @@ To register your Component, you'll need a JSON configuration file looking a lot like this sample: -.. literalinclude:: ../examples/new-card-component.json +.. literalinclude:: ../../examples/new-card-component.json :language: json :componentid: diff --git a/docs/extensions/datatypes.rst b/docs/extending/extensions/datatypes.rst similarity index 95% rename from docs/extensions/datatypes.rst rename to docs/extending/extensions/datatypes.rst index 2e3cd0df..0eef6e63 100644 --- a/docs/extensions/datatypes.rst +++ b/docs/extending/extensions/datatypes.rst @@ -29,7 +29,7 @@ In your Project, these files must be placed accordingly: To begin, let's examine the ``sample-datatype`` included with Arches: -.. literalinclude:: ../examples/sample_datatype.py +.. literalinclude:: ../../examples/sample_datatype.py :language: python :linenos: @@ -49,7 +49,7 @@ You can get a pretty good idea of what methods you need to implement by looking at the ``BaseDataType`` class in the Arches source code located at ``arches/app/datatypes/base.py`` and below: -.. literalinclude:: ../examples/base.py +.. literalinclude:: ../../examples/base.py :language: python :linenos: @@ -102,7 +102,7 @@ Configuring your DataType You'll need to populate the ``details`` dictionary to configure your new DataType. -.. literalinclude:: ../examples/sample_datatype.py +.. literalinclude:: ../../examples/sample_datatype.py :language: python :lines: 7-17 @@ -167,7 +167,7 @@ your Python file's ``details`` dictionary for ``configcomponent``. Pulling it all together, here's the JavaScript portion of Arches' ``date`` DataType. -.. literalinclude:: ../examples/date.js +.. literalinclude:: ../../examples/date.js :language: javascript @@ -180,7 +180,7 @@ conditionally rendered by Knockout.js if the search view is active. Here's the one from the ``boolean`` datatype: -.. literalinclude:: ../examples/boolean.htm +.. literalinclude:: ../../examples/boolean.htm :language: htmldjango :lines: 2-10 @@ -193,7 +193,7 @@ Arches' built-in ``date`` DataType does not use the Django template a more sophisticated example of the component logic needed: -.. literalinclude:: ../examples/date.htm +.. literalinclude:: ../../examples/date.htm :language: django @@ -217,13 +217,13 @@ Arches' ``boolean`` DataType has the following ``defaultconfig``: You can see the corresponding data bindings in the Django template: -.. literalinclude:: ../examples/boolean.htm +.. literalinclude:: ../../examples/boolean.htm :language: htmldjango :lines: 12-25 And finally, here is the ``boolean`` DataType's JavaScript file in its entirety: -.. literalinclude:: ../examples/boolean.js +.. literalinclude:: ../../examples/boolean.js :language: javascript Registering your DataType diff --git a/docs/extensions/functions.rst b/docs/extending/extensions/functions.rst similarity index 100% rename from docs/extensions/functions.rst rename to docs/extending/extensions/functions.rst diff --git a/docs/extensions/plugins.rst b/docs/extending/extensions/plugins.rst similarity index 97% rename from docs/extensions/plugins.rst rename to docs/extending/extensions/plugins.rst index e663c094..d754bc9d 100644 --- a/docs/extensions/plugins.rst +++ b/docs/extending/extensions/plugins.rst @@ -13,7 +13,7 @@ To register your Plugin, you'll need a JSON configuration file looking a lot like this sample: -.. literalinclude:: ../examples/sample-plugin.json +.. literalinclude:: ../../examples/sample-plugin.json :language: json diff --git a/docs/extensions/resource-reports.rst b/docs/extending/extensions/resource-reports.rst similarity index 100% rename from docs/extensions/resource-reports.rst rename to docs/extending/extensions/resource-reports.rst diff --git a/docs/extensions/search-filters.rst b/docs/extending/extensions/search-filters.rst similarity index 100% rename from docs/extensions/search-filters.rst rename to docs/extending/extensions/search-filters.rst diff --git a/docs/extensions/widgets.rst b/docs/extending/extensions/widgets.rst similarity index 95% rename from docs/extensions/widgets.rst rename to docs/extending/extensions/widgets.rst index bce7b91c..96882ae9 100644 --- a/docs/extensions/widgets.rst +++ b/docs/extending/extensions/widgets.rst @@ -30,7 +30,7 @@ Configuring your Widget To start, here is a sample Widget JSON file: -.. literalinclude:: ../examples/sample-widget.json +.. literalinclude:: ../../examples/sample-widget.json :language: json The most important field here is the ``datatype`` field. This controls @@ -56,7 +56,7 @@ controls how data from your Widget is presented in a Report. Here is an example: -.. literalinclude:: ../examples/sample-widget.htm +.. literalinclude:: ../../examples/sample-widget.htm :language: htmldjango To pull it all together, you'll need to write a complementary @@ -67,7 +67,7 @@ component with a ``viewModel`` corresponding to your Widget's ``view`` Here is an example, continuing with our ``sample-widget``: -.. literalinclude:: ../examples/sample-widget.js +.. literalinclude:: ../../examples/sample-widget.js :language: JavaScript Registering your Widget diff --git a/docs/extensions/workflows.rst b/docs/extending/extensions/workflows.rst similarity index 97% rename from docs/extensions/workflows.rst rename to docs/extending/extensions/workflows.rst index 44685477..6fa30706 100644 --- a/docs/extensions/workflows.rst +++ b/docs/extending/extensions/workflows.rst @@ -6,7 +6,7 @@ Workflows are a type of :doc:`Plugin ` that can simplify the data entry In other words, instead of using this interface to create a new resource: -.. figure:: ../images/full-editor.jpg +.. figure:: ../../images/full-editor.jpg :width: 100% :align: center @@ -14,7 +14,7 @@ In other words, instead of using this interface to create a new resource: ...a workflow can pare down the data entry interface to look something like this: -.. figure:: ../images/quick-workflow-example.jpg +.. figure:: ../../images/quick-workflow-example.jpg :width: 100% :align: center @@ -50,7 +50,7 @@ Registration JSON Because Workflows are just Plugins, their registration configurations are constructed the same. See :ref:`Registering your Plugin` for more about how to create the JSON file. For our purposes, it will look like this: -.. literalinclude:: ../examples/quick-resource-create-workflow.json +.. literalinclude:: ../../examples/quick-resource-create-workflow.json :language: json Main UI Component @@ -58,7 +58,7 @@ Main UI Component The HTML for this component ``quick-resource-create-workflow.htm`` can be exceptionally simple (just two lines): -.. literalinclude:: ../examples/quick-resource-create-workflow.htm +.. literalinclude:: ../../examples/quick-resource-create-workflow.htm :language: htmldjango The workflow's behavior is defined in ``quick-resource-create-workflow.js``. You'll begin with the boilerplate content below. Note that: @@ -240,7 +240,7 @@ Full Example Workflow Putting it all together, our main workflow component looks like this: -.. literalinclude:: ../examples/quick-resource-create-workflow.js +.. literalinclude:: ../../examples/quick-resource-create-workflow.js :language: javascript Step Components diff --git a/docs/extending/index.rst b/docs/extending/index.rst new file mode 100644 index 00000000..eb4ac01f --- /dev/null +++ b/docs/extending/index.rst @@ -0,0 +1,15 @@ +============ +Extending +============ + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: Extending Arches + :maxdepth: 2 + + creating-extensions + creating-new-map-layers + create-html-export-templates diff --git a/docs/index.txt b/docs/index.bak similarity index 100% rename from docs/index.txt rename to docs/index.bak diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..79b0a390 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,35 @@ +======== +home +======== + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: Getting Started + :maxdepth: 1 + + introduction/index + installing/index + +.. toctree:: + :caption: For Arches Users + :maxdepth: 1 + + configuring/index + administering/index + user-guide/index + +.. toctree:: + :caption: For Arches Developers + :maxdepth: 1 + + extending/index + developing/index + +.. toctree:: + :caption: Deploying Arches + :maxdepth: 1 + + deployment/index \ No newline at end of file diff --git a/docs/installing/index.rst b/docs/installing/index.rst new file mode 100644 index 00000000..bccabcdb --- /dev/null +++ b/docs/installing/index.rst @@ -0,0 +1,15 @@ +============ +Installing +============ + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: Installing + :maxdepth: 1 + + requirements-and-dependencies + installation + projects-and-packages diff --git a/docs/installation.txt b/docs/installing/installation.txt similarity index 99% rename from docs/installation.txt rename to docs/installing/installation.txt index 66b0485c..b2815bb4 100644 --- a/docs/installation.txt +++ b/docs/installing/installation.txt @@ -186,7 +186,7 @@ What Next? * To use the Arches Collector mobile app with your project, see :ref:`Arches Collector Checklist` -* Read more about :doc:`Projects and Packages ` +* Read more about :ref:`Projects and Packages ` Common Errors ------------- diff --git a/docs/projects-and-packages.txt b/docs/installing/projects-and-packages.txt similarity index 100% rename from docs/projects-and-packages.txt rename to docs/installing/projects-and-packages.txt diff --git a/docs/requirements-and-dependencies.txt b/docs/installing/requirements-and-dependencies.txt similarity index 100% rename from docs/requirements-and-dependencies.txt rename to docs/installing/requirements-and-dependencies.txt diff --git a/docs/introduction/index.rst b/docs/introduction/index.rst new file mode 100644 index 00000000..e04fa915 --- /dev/null +++ b/docs/introduction/index.rst @@ -0,0 +1,14 @@ +============ +Introduction +============ + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: Introduction + :maxdepth: 1 + + overview + release-process diff --git a/docs/overview.txt b/docs/introduction/overview.txt similarity index 100% rename from docs/overview.txt rename to docs/introduction/overview.txt diff --git a/docs/release-process.txt b/docs/introduction/release-process.txt similarity index 100% rename from docs/release-process.txt rename to docs/introduction/release-process.txt diff --git a/docs/creating-resources.txt b/docs/user-guide/creating-resources.txt similarity index 89% rename from docs/creating-resources.txt rename to docs/user-guide/creating-resources.txt index 7f974602..5e8c09d9 100644 --- a/docs/creating-resources.txt +++ b/docs/user-guide/creating-resources.txt @@ -8,7 +8,7 @@ Resource Manager You may create new Resources only if you have access to the Resource Manager page. From there, you will begin by choosing which Resource Model you would like to use. Note that a Resource Model must have its status set to **active** for it to appear in the Resource Manager. -.. figure:: images/Resource-Manager.png +.. figure:: ../images/Resource-Manager.png Your Resource Manager page may look different than this image, depending on what Resource Models you have set up in your database. @@ -20,7 +20,7 @@ The Resource Editor is used to create new or edit existing Resources. On the lef To begin, select a card, enter data, and click Add. Some cards may allow multiple instances, in which case you will be able to add as many of the same type as you want. -.. figure:: images/edit-resource-simple-card.gif +.. figure:: ../images/edit-resource-simple-card.gif Simple data entry in Arches. @@ -28,7 +28,7 @@ Once you have saved data for a resource, you can see a full summary by selecting In some cases, cards will be nested within other cards, as in the example of adding a geo-location below. -.. figure:: images/edit-resource-nested-card.gif +.. figure:: ../images/edit-resource-nested-card.gif Created nested data in Arches. @@ -39,25 +39,25 @@ If you are a member of the Resource Editor group, all of your edits--either crea 1. Resource Editor makes an edit: - .. image:: images/prov-edits-submitted.png + .. image:: ../images/prov-edits-submitted.png 2. For Resource Reviewers, search results indicate provisional data: - .. image:: images/prov-edits-search-result.png + .. image:: ../images/prov-edits-search-result.png `Resource Editors only see provisional data while using the resource editor.` 3. Resource Reviewer will be prompted to Q/A the edit: - .. image:: images/prov-edits-qa-prompt.png + .. image:: ../images/prov-edits-qa-prompt.png 4. Accept or Decline: - .. image:: images/prov-edits-qa-dialog.png + .. image:: ../images/prov-edits-qa-dialog.png 5. Approved edits are immediately visible: - .. image:: images/prov-edits-final.png + .. image:: ../images/prov-edits-final.png .. tip:: A Resource Reviewer can also use the "Q/A Type" search filter (see images above) to only find resources with (or without) provisional edits. @@ -76,7 +76,7 @@ From the Resource Editor you can also access the Related Resources Editor, which After a relation has been created, you can further refine its properties, such as what type of relation it is, how long it lasted, etc. While viewing the relation in grid mode, begin by selecting the relation in the table. You will see the "Delete Selected" button appear. Next click "relation properties", enter the information, and don't forget to "Save" when finished. -.. figure:: images/create-resource-relation.gif +.. figure:: ../images/create-resource-relation.gif Creating a relationship between two resource in Arches, and adding properties to that relationship. diff --git a/docs/deleting-resources.txt b/docs/user-guide/deleting-resources.txt similarity index 100% rename from docs/deleting-resources.txt rename to docs/user-guide/deleting-resources.txt diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst new file mode 100644 index 00000000..0b73b698 --- /dev/null +++ b/docs/user-guide/index.rst @@ -0,0 +1,15 @@ +============ +User Guide +============ + +These sections show off various features and styles of this theme. +They should help you understand how this theme behaves and how others are using it. +See the sections in the primary sidebar and below to explore. + +.. toctree:: + :caption: User Guide + :maxdepth: 2 + + creating-resources + deleting-resources + searching diff --git a/docs/searching.txt b/docs/user-guide/searching.txt similarity index 100% rename from docs/searching.txt rename to docs/user-guide/searching.txt diff --git a/requirements.txt b/requirements.txt index c04910f1..b9070e97 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,5 @@ -Sphinx==4.2.0 -sphinx_rtd_theme==0.5.2 -docutils==0.16 +"Sphinx<6" # latest pydata theme (0.12.0) is not compatible with Sphinx > 6 +pydata-sphinx-theme==0.12.0 readthedocs-sphinx-ext==2.1.4 sphinxcontrib-httpdomain requests[security] - -sphinx-autobuild \ No newline at end of file