Skip to content

Commit

Permalink
Merge pull request #4 from INDIGO-Initiative/2023-09-01
Browse files Browse the repository at this point in the history
.readthedocs.yaml, fix build & show all content in docs
  • Loading branch information
odscjames authored Sep 5, 2023
2 parents 4a0e644 + 36122a4 commit 37da4b8
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 4 deletions.
23 changes: 23 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.8"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: requirements.txt
- path: .
19 changes: 15 additions & 4 deletions docs/data-dictionary/joining_up_initiative.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,23 @@ This is a list. One Joining Up Initiative can have multiple items of data. One i
:path: /properties/departments/items


Documents
---------
Headline evaluation URL
-----------------------

This is a list. One Joining Up Initiative can have multiple items of data. One item of data is defined as:

.. datadictionary::
:schema: joining_up_initiative.json
:path: /properties/headline_evaluation/items

This is a list of supporting documentation for this Joining Up Initiative. One Joining Up Initiative can have multiple items of data. One item of data is defined as:


Other evaluation materials
--------------------------

This is a list. One Joining Up Initiative can have multiple items of data. One item of data is defined as:

.. datadictionary::
:schema: joining_up_initiative.json
:path: /properties/documents/items
:path: /properties/other_evaluation_materials/items

3 changes: 3 additions & 0 deletions docs/versions_changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ Increments to Major numbers:
Changelog
---------

Removed documents section from docs (this was stopping docs building)
Added existing "Headline evaluation URL" and "Other evaluation materials" sections to docs

1.1.0 - 2023-04-25
~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 37da4b8

Please sign in to comment.