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

Modern theme and more options #106

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Conversation

DeeliN221
Copy link

For issure #105

Tested on my WSL ubuntu, there may be something need further fix.

@certik
Copy link
Owner

certik commented Oct 20, 2023

@m3lab-zzl I approved the runs, now the CI should run automatically for you from now on.

@certik
Copy link
Owner

certik commented Oct 20, 2023

You have to adjust the CI to build it, I think you require some new packages in this PR.

Zhilin Zheng and others added 2 commits October 20, 2023 16:16
try to install requirements before building
@DeeliN221 DeeliN221 temporarily deployed to Testing October 20, 2023 08:24 — with GitHub Actions Inactive
@DeeliN221
Copy link
Author

Yes I did add a few PyPI package requirements, and forgot to edit CI.yml correspondingly.

I updated CI.yml, waiting for the test result.

@DeeliN221
Copy link
Author

Hi @certik This build process is done, but CI stuck at some SSH key things.

@certik certik temporarily deployed to Testing October 20, 2023 10:22 — with GitHub Actions Inactive
@certik
Copy link
Owner

certik commented Oct 20, 2023

Thanks! For the ssh keys to work I think one must submit as a branch in the repository itself, I just did it here: #107 ,let's see how the website looks like.

@DeeliN221
Copy link
Author

Great, which theme to use is just a personal choice, no good or bad. I create this PR to make some sort of contribution to thank you for the wonderful and concise notes. Feel free to make your decision.

@certik
Copy link
Owner

certik commented Oct 20, 2023

Awesome, here is the link of the test page: https://certik.gitlab.io/tpr-test/107/merge/. Thank you so much for improving this. I am still looking for people to help out, I think the notes can be improved and polished.

I like the sphinx_book_theme theme the most, but I would like the navigation to be all on the left, like the "Light ReadTheDocs theme". Do you know how to do that?

The other thing I still need to check if the URLs of pages have changed or not (ideally not).

@DeeliN221
Copy link
Author

Awesome, here is the link of the test page: https://certik.gitlab.io/tpr-test/107/merge/. Thank you so much for improving this. I am still looking for people to help out, I think the notes can be improved and polished.

I like the sphinx_book_theme theme the most, but I would like the navigation to be all on the left, like the "Light ReadTheDocs theme". Do you know how to do that?

The other thing I still need to check if the URLs of pages have changed or not (ideally not).

Sadly I am not familiar with the second sidebar of the book theme, I am also seeking a work around to customize TOC and sidebar within this theme, and will update here as soon as I figure out how.

@DeeliN221
Copy link
Author

@certik I spent two days trying to customize the TOC sidebar, but did not succeed.

Two major problems:

  • Even though the right sidebar can be hidden, the article content (in the middile) will not auto expand its width to fill the whole webpage.
  • Expand primary sidebar to section level ( such as 8.9.1 instead of 8.9 ) can not be easily achieved in both pydata and book theme. I assume the underline reason is the design idea of these two themes, they show page relation in left sidebar only, not including sections inside pages.

image

There may be a final solution, but to save time, currently, I suggest to just settle with the built-in sphinx-book-theme, and get used to the floating TOC shown in the right part, which is the same when we read articles in many websites.

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