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

Relegated responsibility of the top-level table of contents to the dea-docs repo instead #1169

Merged

Conversation

benji-glitsos-ga
Copy link
Collaborator

@benji-glitsos-ga benji-glitsos-ga commented Jan 8, 2024

(cherry picked from commit 01f5718)

Proposed changes

Relegated responsibility of the top-level table of contents to the dea-docs repo instead because this allows the use of sub-headings in the sidebar of the DEA Knowledge Hub website. It also makes sense that the website should manage the structure of its own sidebar. The dea-notebooks repo still manages its own notebooks table of contents trees (toctrees) below the top level.

Also, I removed the redundant :caption: properties on the toctrees because they contained the same content as the page title, and were therefore redundant.

Closes issues (optional)

Checklist (replace [ ] with [x] to check off)

  • Notebook created using the DEA-notebooks template
  • Remove any unused Python packages from Load packages
  • Remove any unused/empty code cells
  • Remove any guidance cells (e.g. General advice)
  • Ensure that all code cells follow the PEP8 standard for code. The jupyterlab_code_formatter tool can be used to format code cells to a consistent style: select each code cell, then click Edit and then one of the Apply X Formatter options (YAPF or Black are recommended).
  • Include relevant tags in the final notebook cell (refer to the DEA Tags Index, and re-use tags if possible)
  • Clear all outputs, run notebook from start to finish, and save the notebook in the state where all cells have been sequentially evaluated
  • Test notebook on both the NCI and DEA Sandbox (flag if not working as part of PR and ask for help to solve if needed)
  • If applicable, update the Notebook currently compatible with the NCI|DEA Sandbox environment only line below the notebook title to reflect the environments the notebook is compatible with

Copy link
Collaborator

@erialC-P erialC-P left a comment

Choose a reason for hiding this comment

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

Hey Benji, this all seems reasonable and logical to me.
Thanks! Claire

@benji-glitsos-ga benji-glitsos-ga merged commit 33f8788 into develop Jan 8, 2024
1 check failed
@benji-glitsos-ga benji-glitsos-ga deleted the feature/moved-top-level-table-of-contents branch January 8, 2024 01:21
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