docs: fixes issue of multiple h1 present in python docs #189
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.
Summary of problem
pdoc
have multipleh1
tags present due to the sidebar having anh1
tagSummary of change
As per Pdoc's docs on custom templates
pdoc
to generate docs indocs-templates
directory.make build-docs
command to have a--template-dir docs-templates
flag so it uses the templates fromdocs-templates
directory.docs-templates/html.mako
template to fix multipleh1
issueRelated issues
Test Plan
make build-docs
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
coreDriverInterfaceSupported.json
file has been updated (if needed)Along with the associated array insupertokens_python/constants.py
frontendDriverInterfaceSupported.json
file has been updated (if needed)Changes to the version if neededInsetup.py
Insupertokens_python/constants.py
git tag
) in the formatvX.Y.Z
, and then find the latest branch (git branch --all
) whoseX.Y
is greater than the latest released tag.If have added a new web framework, update thesupertokens_python/utils.py
file to include that in theFRAMEWORKS
variableIf added a new recipe that has a User type with extra info, then be sure to change the User type in supertokens_python/types.pyRemaining TODOs for this PR
No TODOs remaining