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.

Sign up for GitHub

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

299 improve schema reference #370

Merged
merged 28 commits into from
Apr 26, 2023
Merged

299 improve schema reference #370

Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
d3b0793
requirements.txt: Upgrade sphinxcontrib-opendataservices
duncandewhurst Nov 11, 2022
b9626d4
manage.py: Add a pre-commit script to update schema reference docs
duncandewhurst Nov 11, 2022
76400b5
docs/examples: reorder contracting processes, add missing fields
duncandewhurst Nov 11, 2022
389a54d
docs/reference/schema.md: Refactor, add definitions and examples
duncandewhurst Nov 11, 2022
819f9b2
docs/reference/schema.md: Use Sphinx Tabs for schema tables and examples
duncandewhurst Nov 11, 2022
3dacc5b
manage.py: Fix lint errors
duncandewhurst Nov 11, 2022
d634dac
Merge 0.9-dev into 299-improve-schema-reference
jpmckinney Dec 1, 2022
5268c14
feat: Fix manage.py and update requirements to run make
jpmckinney Dec 1, 2022
d0c6cd7
Merge branch '0.9-dev' into 299-improve-schema-reference
jpmckinney Dec 1, 2022
b0099cc
Merge 0.9-dev into 299-improve-schema-reference
jpmckinney Dec 2, 2022
c558d19
docs/reference/schema.md: Use sphinx-design tabs
duncandewhurst Feb 15, 2023
bf176e0
docs/reference: Update introductory text
duncandewhurst Feb 15, 2023
d222951
manage.py: Handle paths that don't appear in the example data
duncandewhurst Feb 15, 2023
ba3c3c9
manage.py: Fix lint errors
duncandewhurst Feb 15, 2023
fd8dcf7
manage.py: Handle nested properties in reference lists and directives
duncandewhurst Mar 21, 2023
5b38dcc
manage.py: Fix lint errors
duncandewhurst Mar 21, 2023
6d73eeb
docs/reference/schema.md: Reduce repetition of content in the schema
duncandewhurst Mar 21, 2023
189659a
docs: Integrate worked example and schema reference
duncandewhurst Mar 23, 2023
e29c23c
Don't use colon fence extension
duncandewhurst Mar 23, 2023
1f023dc
pull_request_template.md: Update merge checklist
duncandewhurst Mar 23, 2023
8ed9a10
Update changelog
duncandewhurst Mar 23, 2023
42299b1
docs/reference/changelog.md: Fix incorrect PR number
duncandewhurst Mar 23, 2023
55a2848
Merge branch '0.9-dev' into 299-improve-schema-reference
duncandewhurst Mar 23, 2023
22529f1
docs/guidance/example.md: Add links to field anchors
duncandewhurst Mar 23, 2023
ec0041e
chore: Fix broken refs
jpmckinney Mar 25, 2023
1ed9476
Update docs/conf.py
duncandewhurst Mar 29, 2023
e65bbf5
docs/reference/schema.md: Use field-description directive
duncandewhurst Mar 29, 2023
dbd0f97
docs: Fix manage.py docstring
jpmckinney Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_static/i18n.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sector,Project sector,False,
purpose,Project purpose,True,
additionalClassifications,Additional classifications,False,
additionalClassifications,Classification,False,
additionalClassifications/scheme,Scheme,True,
additionalClassifications/scheme,Scheme,False,
additionalClassifications/id,ID,True,
additionalClassifications/description,Description,True,
additionalClassifications/uri,URI,False,
Expand Down
3 changes: 1 addition & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
'sphinxcontrib.jsonschema',
'sphinxcontrib.opencontracting',
'sphinxcontrib.opendataservices',
'sphinx_design',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -85,8 +86,6 @@
smartquotes = False

# MyST configuration.
# Disable dollarmath, which uses MathJax for a string like: "If Alice has $100 and Bob has $1..."
# https://myst-parser.readthedocs.io/en/latest/using/intro.html#sphinx-configuration-options
myst_enable_extensions = ['linkify']
myst_heading_anchors = 6
myst_heading_slug_func = make_id
Expand Down
Loading