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

[INFRA] Publish schema tools API docs to additional ReadTheDocs site #1491

Merged
merged 9 commits into from
May 19, 2023

Conversation

bendhouseart
Copy link
Collaborator

Read the docs now supports building documentation from mono repos, as such extra fluff and kludges previously required to publish a read the docs page for schema tools have been removed.

Rendered sites built of this branch can be viewed below:

schema tools rtd
bids rtd

Will need to update schema code project on RTD bids-standard/bids-specification and point to config file at tools/schemacode/.readthedocs.yaml to finalize after merge, see:

Screenshot 2023-05-17 at 6 01 24 PM

@bendhouseart bendhouseart added the enhancement New feature or request label May 17, 2023
@codecov
Copy link

codecov bot commented May 17, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (448e21e) 87.75% compared to head (fb83c33) 87.75%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1491   +/-   ##
=======================================
  Coverage   87.75%   87.75%           
=======================================
  Files          14       14           
  Lines        1282     1282           
=======================================
  Hits         1125     1125           
  Misses        157      157           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@Remi-Gau Remi-Gau left a comment

Choose a reason for hiding this comment

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

Not sure that I understand what the requirements.txt is needed but as one your commit message says "what works work"

@effigies effigies changed the title [ENH] Mono read the docs [INFRA] Publish schema tools API docs to additional ReadTheDocs site May 19, 2023
@effigies effigies merged commit d7f6cae into bids-standard:master May 19, 2023
@bendhouseart
Copy link
Collaborator Author

Not sure that I understand what the requirements.txt is needed but as one your commit message says "what works works

RTD uses the project folder as the root and we (more or less) use the same dependencies for the bids spec generated on RTD as we do for schema-code docs. Now the config file for the schema docs more closely resembles bids-specificiation/readthedocs.yaml. I knew Chris was going to do a squash and merge so I wasn't the most clear with my commit messages, but what works is the original bids-specification/readthedocs.yaml ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants