Skip to content

docs: fixes issue of multiple h1 present in python docs #189

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

Merged
merged 11 commits into from
Jul 6, 2022

Conversation

st-jay
Copy link
Contributor

@st-jay st-jay commented Jun 26, 2022

Summary of problem

  • The docs built using pdoc have multiple h1 tags present due to the sidebar having an h1 tag

image

Summary of change

As per Pdoc's docs on custom templates

  • I added the default HTML templates used by pdoc to generate docs in docs-templates directory.
  • Updated the make build-docs command to have a --template-dir docs-templates flag so it uses the templates from docs-templates directory.
  • Updated the docs-templates/html.mako template to fix multiple h1 issue
- <h1>Index</h1>
+ <h2>Index</h2>

Related issues

Test Plan

  • Built the docs using make build-docs
  • Compared the built docs to docs currently present on production manually

Screenshots

This Drive folder contains two folders with screenshots - one with the docs currently live on production, and the other with the updated docs.

Documentation changes

No documentation changes required

Checklist for important updates

  • Changelog has been updated
  • coreDriverInterfaceSupported.json file has been updated (if needed)
    • Along with the associated array in supertokens_python/constants.py
  • frontendDriverInterfaceSupported.json file has been updated (if needed)
  • Changes to the version if needed
    • In setup.py
    • In supertokens_python/constants.py
  • Had installed and ran the pre-commit hook
  • Issue this PR against the latest non released version branch.
    • To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
    • If no such branch exists, then create one from the latest released branch.
  • If have added a new web framework, update the supertokens_python/utils.py file to include that in the FRAMEWORKS variable
  • If added a new recipe that has a User type with extra info, then be sure to change the User type in supertokens_python/types.py

Remaining TODOs for this PR

No TODOs remaining

@st-jay st-jay self-assigned this Jun 26, 2022
@st-jay st-jay requested a review from nkshah2 June 26, 2022 10:55
@st-jay st-jay changed the base branch from 0.9 to 0.10 July 6, 2022 06:18
@st-jay st-jay requested review from rishabhpoddar and nkshah2 and removed request for nkshah2 and rishabhpoddar July 6, 2022 08:54
@nkshah2
Copy link
Contributor

nkshah2 commented Jul 6, 2022

@st-jay Formatting of code blocks seems to be different (2.png in the drive link)

@rishabhpoddar rishabhpoddar merged commit c65cca5 into 0.10 Jul 6, 2022
@rishabhpoddar rishabhpoddar deleted the fix-multiple-h1-issue branch July 6, 2022 14:12
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.

4 participants