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.

Sign up for GitHub

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

Jump to bottom

Switching to conda-sphinx-theme plus reorganizing the site a bit #370

Merged
merged 9 commits into from
Nov 10, 2023
Merged

Switching to conda-sphinx-theme plus reorganizing the site a bit #370

merged 9 commits into from
Nov 10, 2023

Conversation

travishathaway
Copy link
Contributor

@travishathaway travishathaway commented Nov 10, 2023 •
edited

Description

Fixes: #367

This pull request also re-organizes the website. I did this to accommodate the new menu structure. In the top bar, links to other conda projects will be shown alongside conda-libmamba-solver. On the sidebar, I have chosen to organize the docs site into two sections: "User guide" and "Developer guide". The front page was also changed a little bit.

I know these are big changes so please give me feedback. I would be happy to make changes.

Checklist - did you ...

  • Add a file to the news directory (using the template) for the next release's release notes?
  • Add / update necessary tests?
  • Add / update outdated documentation?

@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Nov 10, 2023
@travishathaway @jaimergp
Update news/370-use-conda-sphinx-theme
3539196 
Co-authored-by: jaimergp <jaimergp@users.noreply.github.com>
jaimergp
jaimergp approved these changes Nov 10, 2023
View reviewed changes
Copy link
Contributor

@jaimergp jaimergp left a comment

Choose a reason for hiding this comment

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

Thanks! Looks awesome. You even took care of the redirects! <3

@jaimergp
Copy link
Contributor

I did notice some accessibility issues with the color palette and created an issue at conda-incubator/conda-sphinx-theme#2

@jaimergp
Copy link
Contributor

cc @jezdez who originally put the site together, in case there are further comments. Otherwise I'd merge :)

@jezdez
Copy link
Member

jezdez commented Nov 10, 2023

lemme take a look when I'm back at a computer before merge

@jezdez jezdez self-requested a review November 10, 2023 12:24
@travishathaway
Copy link
Contributor Author

@jaimergp,

The accessibility issues are actually coming from the style sheet in this repository. I am going to delete this file from this repository. Further changes will be made in conda-sphinx-theme.

@jaimergp
Copy link
Contributor

Oh, I see. Cool! Without it it's a bit less brand-y (only the accent color is conda green) but otherwise it looks good in terms of contrast.

@travishathaway
Copy link
Contributor Author

@jaimergp,

I just released a new version of the conda-sphinx-theme that keeps the link colors green and stays, "on brand" 😄.

jaimergp
jaimergp reviewed Nov 10, 2023
View reviewed changes
docs/environment.yml Outdated Show resolved Hide resolved
@travishathaway @jaimergp
Update docs/environment.yml
9c7e940 
Co-authored-by: jaimergp <jaimergp@users.noreply.github.com>
jezdez
jezdez approved these changes Nov 10, 2023
View reviewed changes
Copy link
Member

@jezdez jezdez left a comment

Choose a reason for hiding this comment

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

The links to the other docs sites shouldn't go through the conda-docs, and instead link to the subproject URLs. Less redirects that way.

docs/_templates/navbar_center.html Outdated Show resolved Hide resolved
docs/_templates/navbar_center.html Outdated Show resolved Hide resolved
docs/_templates/navbar_center.html Outdated Show resolved Hide resolved
travishathaway and others added 2 commits November 10, 2023 15:32
@travishathaway @jezdez
Update docs/_templates/navbar_center.html
87f771c 
Co-authored-by: Jannis Leidel <jannis@leidel.info>
@travishathaway @jezdez
Apply suggestions from code review
bcb07bf 
Co-authored-by: Jannis Leidel <jannis@leidel.info>
@travishathaway
Copy link
Contributor Author

@jaimergp and @jezdez, thanks for the review. I do not have the ability to merge this, so one of you will have to do it.

@jezdez jezdez merged commit 125b9b2 into conda:main Nov 10, 2023
13 checks passed
@jaimergp jaimergp mentioned this pull request Nov 11, 2023
Merged
3 tasks
jezdez added a commit that referenced this pull request Nov 13, 2023
@jezdez
Revert "Switching to conda-sphinx-theme plus reorganizing the site a …
b6eb76d 
…bit (#370)"

This reverts commit 125b9b2.
jezdez added a commit that referenced this pull request Nov 13, 2023
@jezdez
Revert theme rollout (#375)
de9ac0c 
* Revert "Small fix to hide scroll bar on sidebar navigation (#373)"

This reverts commit 2e8d75d.

* Revert "Correct Conda to conda. (#372)"

This reverts commit 099d99d.

* Revert "Switching to conda-sphinx-theme plus reorganizing the site a bit (#370)"

This reverts commit 125b9b2.
jezdez
jezdez reviewed Nov 13, 2023
View reviewed changes
docs/conf.py
Comment on lines +106 to +114
redirects = {
"getting-started": "user-guide",
"faq": "user-guide/faq",
"configuration": "user-guide/configuration",
"libmamba-vs-classic": "user-guide/libmamba-vs-classic",
"more-resources": "user-guide/more-resources",
"performance": "user-guide/performance",
"subcommands": "user-guide/subcommands",
}
Copy link
Member

Choose a reason for hiding this comment

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

Something was wrong with this section: #374

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jezdez jezdez jezdez approved these changes

@jaimergp jaimergp jaimergp approved these changes

Assignees
No one assigned
Labels
cla-signed [bot] added once the contributor has signed the CLA
Projects
🔎 Review
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Adopt conda-sphinx-theme
4 participants
@travishathaway @jaimergp @jezdez @conda-bot