initial implementation of pydata theme #274

README.md

@@ -127,15 +127,15 @@ 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
 
         Data model showing only Arches models. (including a caption is optional but encouraged)
 
 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).

docs/arches-collector-checklist.txt → 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

docs/arches-collector-manager.txt → 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.

docs/using-arches-collector.txt → 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,15 +176,15 @@ 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
 
     Note that this user is shown the option to delete The Eliza Jane. Once the project has been synced, deletion will no longer be an option. You will also never be allowed to delete resources that were initially downloaded with the project.
 
 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,15 +211,15 @@ 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
 
     While working in a project, use the icon in the upper right to open the menu from which you can sync, using the "Refresh survey data" button.
 
 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
 

docs/designing-the-database.txt → 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 <loading a package into a project>`. 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
 <https://docs.mapbox.com/mapbox-gl-js/style-spec/#layer-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.
 

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

docs/managing-permissions.txt → 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
 

docs/rdm.txt → 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
 
 
 

docs/two-factor-authentication.rst → docs/administering/two-factor-authentication.rst

@@ -47,15 +47,15 @@ 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
 
     User Profile showing two-factor authentication status.
 
 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,23 +68,23 @@ 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
 
     Two-factor authentication settings page.
 
 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
 
     Two-factor authentication settings page showing QR code.
 
 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