Skip to content

DOC simplify the structure of about and testimonials #28270

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

Closed

Conversation

Charlie-XIAO
Copy link
Contributor

This PR is mainly intended to simplify the work in #28084 towards switching to pydata-sphinx-theme. I made special adjustments so that it can target main without relying on the setup in #28132.

This PR simplifies the structure of the about and testimonials/testimonials pages. In short, it does the following:

  • Used a similar strategy when implementing dropdowns, so that we do not need to repeat the .. raw:: html blocks over and over again. More importantly, the class names are no longer distributed all over the document so it is easier to change class name or styles.
  • Removed the hardcoded image widths and replaced by some css styling, i.e., limiting maximum width to 50% of the container (i.e., ~25% of the article width) and maximum height to 50px (for testimonials/testimonials) and 100px (for about).

There are some other minor changes, such that if undesired, please feel free to let me know so that I can revert:

  • I removed the "history" subsection title on top of the about page, the reason being that two adjacent headings do not look that well (too much space in between) in pydata-sphinx-theme.
  • I made "authors", "documentation team", etc. one level lower, i.e., under the "governance" section.

Copy link

github-actions bot commented Jan 26, 2024

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 5db0bad. Link to the linter CI: here

@glemaitre
Copy link
Member

I see 2 places were we have some weird borders:

image

above and below the figure and:

image

between the logo.

It would be nicer to remove those.

@glemaitre
Copy link
Member

Otherwise the rest of the rendering is fine for me.

@Charlie-XIAO
Copy link
Contributor Author

Charlie-XIAO commented Jan 26, 2024

Thanks for spotting that. I may remove the borders by styling that table, or I'm thinking about not using table but using a bootstrap-style grid instead, so that we do not force four logos in a row on small screens.

I may not have time for this right now, but will come back in a day.

@Charlie-XIAO
Copy link
Contributor Author

Done @glemaitre. For the second table I tried to make the code as simple as possible, but it still kind of looks weird (not the rendering but the source code). Please let me know if it is acceptable.

On my laptop

image
image

On my phone

Copy link
Member

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

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

LGTM. I'll let @glemaitre have another look and merge.

@Charlie-XIAO
Copy link
Contributor Author

I think I'm going to close this one. With sphinx-design on the new_web_theme branch things can be made cleaner.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants