From 9f5850489ea1f281fd8d2faae04a9261a837ca96 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Thu, 18 Jan 2024 12:29:44 -0500 Subject: [PATCH] docs: Merge OCDS Show into Architecture. Copy-edit headings. --- docs/architecture.rst | 10 +++++++--- docs/how-to-add-kfi.rst | 4 ++-- docs/how-to-config-frontend.rst | 4 ++-- docs/index.rst | 12 ++---------- docs/requirements.txt | 8 +------- 5 files changed, 14 insertions(+), 24 deletions(-) diff --git a/docs/architecture.rst b/docs/architecture.rst index dca95408..085536db 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -17,7 +17,6 @@ cove-ocds ``cove_project/`` contains the Django components (settings, URL paths, server). - lib-cove-ocds ------------- @@ -34,8 +33,13 @@ The OCDS Data Review Tool is just one manifestation of software historically kno * lib-cove-web (`opendataservices/lib-cove-web `_): provides a barebones Django configuration, and baseline CSS, JS and templates that are common for all CoVE instances. It is also a place for common functions relating to presentation or display of data or output. Any templates edited here typically affect all CoVE instances. Sometimes this is useful, but for OCDS-only changes, templates can be overridden in cove-ocds. This and cove-ocds are the only places where frontend output and translatable strings should be. * flatten-tool (`opendataservices/flatten-tool `_): a general purpose library for converting data between JSON and CSV/XLS formats. While not CoVE-specific, it is listed here because it is a specialized tool of which the DRT makes heavy use. -Config ------- +OCDS Show +--------- + +`OCDS Show `_ is a JavaScript application for embedding visualizations of OCDS data. The DRT generates data for OCDS Show in ``views.py`` so that it can be embedded in the ``explore_`` templates. Additional functions to help with the data generation for OCDS show are in ``cove_ocds/lib/ocds_show_extra.py``. + +Configuration +------------- Some configuration variables are set in ``COVE_CONFIG``, found in ``cove_project/settings.py``. diff --git a/docs/how-to-add-kfi.rst b/docs/how-to-add-kfi.rst index 8bcb4739..30b6b372 100644 --- a/docs/how-to-add-kfi.rst +++ b/docs/how-to-add-kfi.rst @@ -1,5 +1,5 @@ -How to add to Key Field Information -=================================== +How to add key field information +================================ Key Field Information is a summary of key statistics about the data that's been provided. diff --git a/docs/how-to-config-frontend.rst b/docs/how-to-config-frontend.rst index e93b04c4..98a41061 100644 --- a/docs/how-to-config-frontend.rst +++ b/docs/how-to-config-frontend.rst @@ -1,5 +1,5 @@ -How to replace something hardcoded in the frontend with a configurable variable -================================================================================ +How to replace frontend hardcoding with a configurable variable +=============================================================== Pick a name for the environment variable you want to configure cove with. In this example we use `MY_ENV_VAR`. diff --git a/docs/index.rst b/docs/index.rst index 6c2ec14f..1bfd4a68 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -OCDS Data Review Tool: Developer Documentation -============================================== +OCDS Data Review Tool +===================== .. include:: ../README.rst @@ -20,7 +20,6 @@ The `CoVE `__ documentation might also b how-to-config-frontend how-to-add-kfi tests - ocds-show There are `drafts `__ of another couple how-tos for adding headlines and modifying validation error messages. @@ -56,10 +55,3 @@ This will make the test site available on the local machine only. If you are run ALLOWED_HOSTS='XXX.XXX.XXX.XXX' python manage.py runserver 0.0.0.0:8000 where XXX.XXX.XXX.XXX is the IP address that you'll be using to access the running service. - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/requirements.txt b/docs/requirements.txt index 066ab2f8..a95ae18b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1 @@ --r ../requirements.txt -# sphinx>=4.4.0 requires importlib-metadata>=4.4, but django-bootstrap3 requires <3. -# https://github.com/zostera/django-bootstrap3/issues/608 -# https://github.com/zostera/django-bootstrap4/issues/380 -sphinx<4.4.0 -# sphinx<4.4.4 requires a specific version of furo. -furo==2022.4.7 +furo