docs: fix the issue with sidebar toc levels and people option deprecation #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Akshay Mestry <xa@mes3.dev>
… into feature/migrate-to-rst Signed-off-by: Akshay Mestry <xa@mes3.dev>
Signed-off-by: Akshay Mestry <xa@mes3.dev>
xames3
added
documentation
Signed-off-by: Akshay Mestry <xa@mes3.dev>
.. versionadded:: 2024.09.30
[1] Added new "On this page" section which represents a quick
summary of key takeaways from the whole page.
.. deprecated:: 2024.09.30
[1] Deprecated the use of `people` options from the `contributors`
directive as part of new change from the underlying theme.
Signed-off-by: Akshay Mestry <xa@mes3.dev>
…/TOPSTSCHOOL-OSDMP into feature/migrate-to-rst
xames3
changed the title
github-actions bot
added a commit
that referenced
this pull request
Sep 6, 2024
…tion (#7) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. --------- Signed-off-by: Akshay Mestry <xa@mes3.dev>
xames3
added a commit
that referenced
this pull request
Oct 4, 2024
* build(branching scheme): add new publishing configs Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore(urls): remove unicode replacement for dash Signed-off-by: Akshay Mestry <xa@mes3.dev> * feat(getting started): add new guides as introduction Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(typo): resolve branch name Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(actions): add proper branch references Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(actions): add proper branch references (#3) Signed-off-by: Akshay Mestry <xa@mes3.dev> * docs(open science): correct sidebar toc level Signed-off-by: Akshay Mestry <xa@mes3.dev> * docs(date): documents now show last updated date Signed-off-by: Akshay Mestry <xa@mes3.dev> * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. Signed-off-by: Akshay Mestry <xa@mes3.dev> * docs: fix the issue with sidebar toc levels and people option deprecation (#7) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * ci(force-build): empty commit to force build Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore(process flow): add TOPST git-flow diagram related to: #9 Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/migrate to rst merge to dev (#13) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/assets → dev merge (#14) * chore(processes): add flow and story map diagrams --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: remove older git-flow Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/migrate-to-rst ← dev (#16) * feature/migrate to rst merge to dev (#13) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/assets → dev merge (#14) * chore(processes): add flow and story map diagrams --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: remove older git-flow Signed-off-by: Akshay Mestry <xa@mes3.dev> --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: delete assets/TOPST SCHOOL GitFlow.png * feature/migrate to rst → dev (#17) * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 * feature/migrate-to-rst ← dev (#16) * feature/migrate to rst merge to dev (#13) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 * feature/assets → dev merge (#14) * chore(processes): add flow and story map diagrams * chore: remove older git-flow * chore: delete assets/TOPST SCHOOL GitFlow.png --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/migrate to rst ← dev (#18) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option * feature/migrate-to-rst ← dev (#16) * feature/migrate to rst merge to dev (#13) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 * feature/assets → dev merge (#14) * chore(processes): add flow and story map diagrams * chore: remove older git-flow * chore: delete assets/TOPST SCHOOL GitFlow.png --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * feat!: upstream new web-build and i18n Added support for native i18n. Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(index): resolve issue with indexing Signed-off-by: Akshay Mestry <xa@mes3.dev> * ci(sphinx-build): add support for i18n build Signed-off-by: Akshay Mestry <xa@mes3.dev> * ci(i18n): add support of i18n to main Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/migrate to rst → dev (#19) * ci(i18n): add support of i18n to main --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(i18n): resolve issue with i18n URL parsing Signed-off-by: Akshay Mestry <xa@mes3.dev> * style!: enable responsiveness of the website Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: add link to the preview site (#24) * chore: upstream all to remote (no change) Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(wsim): update wsim explanation for python Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(requirements): resolve the pip packages Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(build): resolve page build issue (#29) - this issue was particularly affecting the page building action due to a typo left over from previous merge conflict. this commit resolves that issue. * feature/water module → dev (#30) * fix(build): resolve page build issue * fix(merge): remove merge headers * major! feature/water module → dev (#31) * fix(build): resolve page build issue - this issue was particularly affecting the page building action due to a typo left over from previous merge conflict. this commit resolves that issue. * fix(merge): remove merge headers - this commit removes the leftover merge headers (both incoming and current) from the files which resulted in faulty rendering. * refactor: drop naming prefixes Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/water module (#32) * fix(build): resolve page build issue - this issue was particularly affecting the page building action due to a typo left over from previous merge conflict. this commit resolves that issue. Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(merge): remove merge headers - this commit removes the leftover merge headers (both incoming and current) from the files which resulted in faulty rendering. Signed-off-by: Akshay Mestry <xa@mes3.dev> * refactor: drop naming prefixes Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: fix redundancy with archived files Signed-off-by: Akshay Mestry <xa@mes3.dev> --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * add folium maps (#33) * fix(build): resolve page build issue - this issue was particularly affecting the page building action due to a typo left over from previous merge conflict. this commit resolves that issue. * fix(merge): remove merge headers - this commit removes the leftover merge headers (both incoming and current) from the files which resulted in faulty rendering. * refactor: drop naming prefixes * chore: fix redundancy with archived files * feat(folium): add support for folium maps * fix: remove leftover merge header * fix: patch the merge trace * feat(demo): changes ready for demonstration --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> --------- Signed-off-by: Akshay Mestry <xa@mes3.dev>
github-actions bot
added a commit
that referenced
this pull request
Oct 4, 2024
* build(branching scheme): add new publishing configs Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore(urls): remove unicode replacement for dash Signed-off-by: Akshay Mestry <xa@mes3.dev> * feat(getting started): add new guides as introduction Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(typo): resolve branch name Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(actions): add proper branch references Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(actions): add proper branch references (#3) Signed-off-by: Akshay Mestry <xa@mes3.dev> * docs(open science): correct sidebar toc level Signed-off-by: Akshay Mestry <xa@mes3.dev> * docs(date): documents now show last updated date Signed-off-by: Akshay Mestry <xa@mes3.dev> * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. Signed-off-by: Akshay Mestry <xa@mes3.dev> * docs: fix the issue with sidebar toc levels and people option deprecation (#7) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * ci(force-build): empty commit to force build Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore(process flow): add TOPST git-flow diagram related to: #9 Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/migrate to rst merge to dev (#13) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/assets → dev merge (#14) * chore(processes): add flow and story map diagrams --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: remove older git-flow Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/migrate-to-rst ← dev (#16) * feature/migrate to rst merge to dev (#13) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/assets → dev merge (#14) * chore(processes): add flow and story map diagrams --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: remove older git-flow Signed-off-by: Akshay Mestry <xa@mes3.dev> --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: delete assets/TOPST SCHOOL GitFlow.png * feature/migrate to rst → dev (#17) * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 * feature/migrate-to-rst ← dev (#16) * feature/migrate to rst merge to dev (#13) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 * feature/assets → dev merge (#14) * chore(processes): add flow and story map diagrams * chore: remove older git-flow * chore: delete assets/TOPST SCHOOL GitFlow.png --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/migrate to rst ← dev (#18) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option * feature/migrate-to-rst ← dev (#16) * feature/migrate to rst merge to dev (#13) * fix(actions): add proper branch references * docs(open science): correct sidebar toc level * docs(date): documents now show last updated date * docs(updated): deprecate use of people option .. versionadded:: 2024.09.30 [1] Added new "On this page" section which represents a quick summary of key takeaways from the whole page. .. deprecated:: 2024.09.30 [1] Deprecated the use of `people` options from the `contributors` directive as part of new change from the underlying theme. * ci(force-build): empty commit to force build * chore(process flow): add TOPST git-flow diagram related to: #9 * feature/assets → dev merge (#14) * chore(processes): add flow and story map diagrams * chore: remove older git-flow * chore: delete assets/TOPST SCHOOL GitFlow.png --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * feat!: upstream new web-build and i18n Added support for native i18n. Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(index): resolve issue with indexing Signed-off-by: Akshay Mestry <xa@mes3.dev> * ci(sphinx-build): add support for i18n build Signed-off-by: Akshay Mestry <xa@mes3.dev> * ci(i18n): add support of i18n to main Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/migrate to rst → dev (#19) * ci(i18n): add support of i18n to main --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(i18n): resolve issue with i18n URL parsing Signed-off-by: Akshay Mestry <xa@mes3.dev> * style!: enable responsiveness of the website Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: add link to the preview site (#24) * chore: upstream all to remote (no change) Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(wsim): update wsim explanation for python Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(requirements): resolve the pip packages Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(build): resolve page build issue (#29) - this issue was particularly affecting the page building action due to a typo left over from previous merge conflict. this commit resolves that issue. * feature/water module → dev (#30) * fix(build): resolve page build issue * fix(merge): remove merge headers * major! feature/water module → dev (#31) * fix(build): resolve page build issue - this issue was particularly affecting the page building action due to a typo left over from previous merge conflict. this commit resolves that issue. * fix(merge): remove merge headers - this commit removes the leftover merge headers (both incoming and current) from the files which resulted in faulty rendering. * refactor: drop naming prefixes Signed-off-by: Akshay Mestry <xa@mes3.dev> * feature/water module (#32) * fix(build): resolve page build issue - this issue was particularly affecting the page building action due to a typo left over from previous merge conflict. this commit resolves that issue. Signed-off-by: Akshay Mestry <xa@mes3.dev> * fix(merge): remove merge headers - this commit removes the leftover merge headers (both incoming and current) from the files which resulted in faulty rendering. Signed-off-by: Akshay Mestry <xa@mes3.dev> * refactor: drop naming prefixes Signed-off-by: Akshay Mestry <xa@mes3.dev> * chore: fix redundancy with archived files Signed-off-by: Akshay Mestry <xa@mes3.dev> --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> * add folium maps (#33) * fix(build): resolve page build issue - this issue was particularly affecting the page building action due to a typo left over from previous merge conflict. this commit resolves that issue. * fix(merge): remove merge headers - this commit removes the leftover merge headers (both incoming and current) from the files which resulted in faulty rendering. * refactor: drop naming prefixes * chore: fix redundancy with archived files * feat(folium): add support for folium maps * fix: remove leftover merge header * fix: patch the merge trace * feat(demo): changes ready for demonstration --------- Signed-off-by: Akshay Mestry <xa@mes3.dev> --------- Signed-off-by: Akshay Mestry <xa@mes3.dev>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
.. versionadded:: 2024.09.30
.. deprecated:: 2024.09.30