search

openownership / data-standard

The Beneficial Ownership Data Standard (BODS) is an open standard providing a specification for modelling and publishing information on the beneficial ownership and control of corporate vehicles
http://standard.openownership.org
Other
62 stars 13 forks source link

Update JSON pointers in docs to reflect 0.4.0 schema updates #521

Closed kd-ods closed 7 months ago

kd-ods commented 10 months ago

Summary of the bug or issue After bringing my dev environment in line with the updated requirements_test.txt, I tried building the docs on the 0.4.0-schema-resdesign branch. I got the following error.

Exception occurred:
  File "/home/work/.local/lib/python3.9/site-packages/pygments/styles/__init__.py", line 53, in get_style_by_name
    raise ClassNotFound("Could not find style class %r in style module." % cls)
pygments.util.ClassNotFound: Could not find style class 'OodsStyle' in style module.
The full traceback has been saved in /tmp/sphinx-err-6chqkzst.log, if you want to report the issue to the developers

Using 'cat' to view the content of /tmp/sphinx-err-6chqkzst.log gives me nothing.

kd-ods commented 10 months ago

@rhiaro - we talked about resolving docs building issues after merging the 0.4.0-schema-resdesign branch.... but I think we should reconsider. (The implicit basis for that decision was that we don't want to block work on other 0.4 issues which depend on the schema redesign, but those issues will ultimately require docs work too.) What do you think about trying to work through the build issues before merging?

rhiaro commented 10 months ago

I've pushed a temporary fix to that error to the 0.4 branch - it now hits the json pointer errors with the docs builds as before.

A quick look, and the version of Pygments has been upgraded by several, so the API for including custom styles might have changed. Will need to dig in further, but it's only syntax highlighting so we can live without it in the meantime. I'm spinning this specific issue into https://github.com/openownership/data-standard-sphinx-theme/issues/85

kd-ods commented 10 months ago

OK. Here's the jsonpointer error:

Exception occurred:
  File "/home/work/.local/lib/python3.9/site-packages/jsonpointer.py", line 291, in walk
    raise JsonPointerException("member '%s' not found in %s" % (part, doc))
jsonpointer.JsonPointerException: member 'Agent' not found in OrderedDict [...]

We think this will be fixed when, in the docs, the pointers on reference.rst page are updated in line with the schema redesign.

kathryn-ods commented 9 months ago

I've edited the JSON pointers on the branch https://github.com/openownership/data-standard/tree/0.4.0-schema-redesign-reference-pointers and have uncovered a new error #546

kathryn-ods commented 8 months ago

Cherry picked this change into a new branch to avoid various merge conflicts. See pull request #569