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

docs: single toctree #74

Closed
wants to merge 1 commit into from
Closed

Conversation

dgarcia360
Copy link

@dgarcia360 dgarcia360 commented Feb 25, 2021

Related issues: #72 #67

This PR rollbacks the custom changes applied to the documentation pages. It also defines the table of contents of the documentation site in a single file (contents.rst).

These modifications will allow us to backport the documentation generation system to other branches with fewer steps: https://github.com/dgarcia360/java-driver/blob/d9505e9fdcd5948611a0b480015cbc3add27b2d2/README-dev.rst#defining-supported-versions

Downsides

Before, all the contents were nicely classified under their parent documentation page. Now, the table of contents will render completely the page.

image

@lauranovich @tzach If you don't like how the sidebar looks, we could render the different sections as dropdowns with the theme redesign.

Testing this PR

  1. Enter the docs directory with cd docs.
  2. Run make preview.
  3. Review the latest table of contents on the sidebar.

docs: defining supported versions

docs: remove folder if exist

docs: supress autolabel warning

docs: removed changelog
@lauranovich
Copy link

Is there a reason Manual is listed as an H1 and an H2?

@dgarcia360
Copy link
Author

The branch schema has recently changed, so we don't need to merge this PR.

@dgarcia360 dgarcia360 closed this Mar 8, 2021
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