Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

changing subheadings in reference page to include spaces #500

Merged
merged 6 commits into from
Nov 13, 2023

Conversation

kathryn-ods
Copy link
Contributor

Overview

  • What does this pull request do? Adds spaces to the subheadings in the reference page
  • How can a reviewer test or examine your changes? building the docs locally and checking the page?
  • Who is best placed to review it? Kadie

(Closes/Relates to) issue: #

Translations

Documentation & Release

@kathryn-ods
Copy link
Contributor Author

Kadie - I just changed the subheadings in the reference page as a small task to practice editing the docs and bring this page in line with the style guide conventions we discussed yesterday. Not sure if I need to do anything re: translations?

Copy link
Collaborator

@kd-ods kd-ods left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The links from within tables will need to be updated to take account of the new headings. It's to do with how the HTML elements are generated from the RST and how the sphinx directives work. So, for example, if you try to follow the AddressType link from the first table on the page, it doesn't work.

In this directive:

.. jsonschema:: ../_build_schema/components.json
   :pointer: /$defs/Address
   :externallinks: {"type":{"url":"#addresstype","text":"AddressType"}}
   :allowexternalrefs:

the 'externallinks' bit needs to change to:

:externallinks: {"type":{"url":"#address-type","text":"Address Type"}}

(This is one of the gnarly things we need to make sure we document in the Handbook!)

@kathryn-ods
Copy link
Contributor Author

Thanks @kd-ods I will get those fixed

@kathryn-ods
Copy link
Contributor Author

@kd-ods I have fixed the broken links in the reference page and checked/fixed relevant links on the other pages

@kathryn-ods

This comment was marked as outdated.

Copy link
Collaborator

@kd-ods kd-ods left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great - I've built this and checked the links. It's ready to merge.

We can do that on a call together if helpful.

@kathryn-ods kathryn-ods merged commit abac084 into main Nov 13, 2023
2 checks passed
@kathryn-ods kathryn-ods deleted the reference_titles branch November 13, 2023 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants