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

[SCHEMA] Use mkdocs-gen-files to generate the glossary #1041

Closed
wants to merge 3 commits into from

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Mar 24, 2022

Closes None, but this should help move us forward on #954.

@tsalo
Copy link
Member Author

tsalo commented Mar 24, 2022

Build fails because it's set to strict and there are the following warnings:

[33mWARNING  -  �[0mA relative path to '99-appendices/14-glossary.md' is included in the 'nav' configuration, which is not found in the documentation files
�[33mWARNING  -  �[0mDocumentation file '/home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/14-glossary.md' contains a link to 'home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/09-entities.md' which is not found in the documentation files.
�[33mWARNING  -  �[0mDocumentation file '/home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/14-glossary.md' contains a link to 'home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/09-entities.md' which is not found in the documentation files.
�[33mWARNING  -  �[0mDocumentation file '/home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/14-glossary.md' contains a link to 'home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/09-entities.md' which is not found in the documentation files.
�[33mWARNING  -  �[0mDocumentation file '/home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/14-glossary.md' contains a link to 'home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/03-modality-agnostic-files.md' which is not found in the documentation files.
�[33mWARNING  -  �[0mDocumentation file '/home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/14-glossary.md' contains a link to 'home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/08-coordinate-systems.md' which is not found in the documentation files.
�[33mWARNING  -  �[0mDocumentation file '/home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/14-glossary.md' contains a link to 'home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/08-coordinate-systems.md' which is not found in the documentation files.
�[33mWARNING  -  �[0mDocumentation file '/home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/99-appendices/14-glossary.md' contains a link to 'home/docs/checkouts/readthedocs.org/user_builds/bids-specification/checkouts/1041/src/03-modality-agnostic-files.md' which is not found in the documentation files.

I think all but the first are probably related to #974. I'm not sure how to work around the first one though. I'm guessing that that warning is raised before the glossary file is created.

@tsalo
Copy link
Member Author

tsalo commented Mar 31, 2022

I am struggling to get this to work with md-tooltips-link. I'm thinking that the best move is to fork it and change the regular expressions used to specify terms. I'm used to the rst approach, so I'm thinking of trying to support ":term:`Name of Term`" or ":term:`Arbitrary Text <Name of Term>`".

@tsalo tsalo marked this pull request as draft May 3, 2022 16:57
@tsalo
Copy link
Member Author

tsalo commented Aug 15, 2022

I'm not sure how to make this work, so I'm going to close it.

@tsalo tsalo closed this Aug 15, 2022
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.

1 participant