Skip to content

Commit

Permalink
schema: Rename rdl_schema.json
Browse files Browse the repository at this point in the history
  • Loading branch information
duncandewhurst committed Aug 2, 2023
1 parent 1826725 commit 2205fa0
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 57 deletions.
4 changes: 2 additions & 2 deletions developer_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To deploy the `dev` branch to the live documentation site, [create a pull reques
* Update the MAJOR.MINOR.PATCH version number in the following files:
* `docs/conf.py`: update `release`
* `docs/reference/schema.md`: update the canonical schema URL
* `schema/rdl_schema.json`: update `id` and `properties/links/prefixItems/properties/href/const`
* `schema/rdls_schema.json`: update `id` and `properties/links/prefixItems/properties/href/const`
* Update the version number and date in `docs/about/changelog.md`

### Set up a local development environment
Expand Down Expand Up @@ -246,7 +246,7 @@ The following files are created by running a build and are not version controlle

#### Configuration

The Sphinx configuration for this project is based on the [Open Data Services Sphinx Base](https://github.com/OpenDataServices/sphinx-base) and is defined in `docs/conf.py`. So that links within the schema work on branches, the configuration replaces `{{version}}` placeholders in `schema/rdl_schema.json` and copies the processed schema to `docs/_readthedocs/html` for inclusion in the built documentation.
The Sphinx configuration for this project is based on the [Open Data Services Sphinx Base](https://github.com/OpenDataServices/sphinx-base) and is defined in `docs/conf.py`. So that links within the schema work on branches, the configuration replaces `{{version}}` placeholders in `schema/rdls_schema.json` and copies the processed schema to `docs/_readthedocs/html` for inclusion in the built documentation.

### Read the Docs

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -415,8 +415,8 @@ def env_before_read_docs(app, env, docnames):
# Process schema and write to _readthedocs/html
if rtd_version is not None:
# Replace {{version}} placeholders
replace_substring_in_json('../schema/rdl_schema.json', '{{version}}', rtd_version, output_path='_readthedocs/html/rdl_schema.json')
replace_substring_in_json('../schema/rdls_schema.json', '{{version}}', rtd_version, output_path='_readthedocs/html/rdls_schema.json')
else:
# Don't replace {{version}} placeholders
replace_substring_in_json('../schema/rdl_schema.json', 'https://rdl-standard.readthedocs.io/en/{{version}}', 'https://rdl-standard.readthedocs.io/en/{{version}}', output_path='_readthedocs/html/rdl_schema.json')
replace_substring_in_json('../schema/rdls_schema.json', 'https://rdl-standard.readthedocs.io/en/{{version}}', 'https://rdl-standard.readthedocs.io/en/{{version}}', output_path='_readthedocs/html/rdls_schema.json')

2 changes: 1 addition & 1 deletion docs/reference/browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This page presents the schema in an interactive browser. Click on schema elements to expand the tree, or use the '+' icon to expand all elements. Use { } to view the underlying schema for any section. Required fields are indicated in **bold**. You can also [view the schema in reference tables](schema.md).

<script src="../../_static/docson/widget.js" data-schema="../rdl_schema.json"></script>
<script src="../../_static/docson/widget.js" data-schema="../rdls_schema.json"></script>
Loading

0 comments on commit 2205fa0

Please sign in to comment.