Modern theme and more options

certik / theoretical-physics

Source code of the Theoretical Physics Reference online book

https://theoretical-physics.com

MIT License

222 stars 48 forks source link

Modern theme and more options #106

Open m3lab-zzl opened 11 months ago

m3lab-zzl commented 11 months ago

For issure #105

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

certik commented 11 months ago

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

certik commented 11 months ago

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

m3lab-zzl commented 11 months ago

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.

m3lab-zzl commented 11 months ago

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

certik commented 11 months ago

Thanks! For the ssh keys to work I think one must submit as a branch in the repository itself, I just did it here: https://github.com/certik/theoretical-physics/pull/107 ,let's see how the website looks like.

m3lab-zzl commented 11 months ago

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 commented 11 months ago

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).

m3lab-zzl commented 11 months ago

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.

m3lab-zzl commented 11 months ago

@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.

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.