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

Change docs theme #15

Merged
merged 1 commit into from
Oct 7, 2023
Merged

Change docs theme #15

merged 1 commit into from
Oct 7, 2023

Conversation

perastov
Copy link
Member

@perastov perastov commented Oct 6, 2023

Откатил обратно размер сайд панели. Так как совсем сжало навигацию.
image

Сейчас вот так. Единственное лого стало старого размера.

image

@perastov perastov requested a review from neexee October 6, 2023 12:13
@@ -73,7 +73,7 @@

html_theme = 'basicstrap'
html_theme_options = {
'sidebar_span': 1,
'sidebar_span': 2,
}
Copy link
Member

@neexee neexee Oct 6, 2023

Choose a reason for hiding this comment

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

Да надо тему менять, эта что-то не очень оказалась. И с сайдбаром эти заморочки, и отцентрировать её нельзя. Настроек добрых нет.

Насколько помню, брал её только потому что всякие сноски типа (!) Important у basicstrap на мой вкус не вырвиглазно выглядели, а у нас их много, у каждого метода API Note написан https://cybsi-cloud-sdk.readthedocs.io/en/latest/api.html#cybsi.cloud.auth.APIKeysAPI.filter.

Сноски называются Admonitions.

У Alabaster эти Admonitions оформлены совершенно никак, у read the docs сильно токсично.

Furo вроде прикольная, можно её попробовать. Book/Press тоже ничего.

https://sphinx-themes.readthedocs.io/en/latest/sample-sites/furo/kitchen-sink/admonitions/

В общем, выбирай :) https://sphinx-themes.readthedocs.io/en/latest/

Можно у cybsi-sdk и cybsi-cloud-sdk разные темы сделать, кмк, это прикольно будет, а то они сейчас слишком похожи друг на друга.

Copy link
Member

@neexee neexee Oct 6, 2023

Choose a reason for hiding this comment

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

Хотя хз, мб и 'sidebar_span': 2 норм фикс. Меня смущало, что лого половину экрана занимает, но мб и пофиг. Зато список слева не обрезается.

В общем, резолви или меняй что-то на свой вкус, мне любой вариант ок.

Copy link
Member Author

Choose a reason for hiding this comment

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

А мне приглядывались темы, да, на book положил взгляд. Узнал что их несколько сегодня).
Хорошо, поиграюсь с этим.

Copy link
Member Author

@perastov perastov Oct 6, 2023

Choose a reason for hiding this comment

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

А если такую тему использовать? Это book. Давай пока её оставлю.
image

Copy link
Member

Choose a reason for hiding this comment

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

Странно, что содержимое левого сайдбара повторяет содержимое правого, а в целом классно.

Copy link
Member

Choose a reason for hiding this comment

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

"localtoc.html" в html_sidebars, наверное, просто лишний. Хз, какой каноничный набор у book в html_sidebars.

Copy link
Member Author

@perastov perastov Oct 7, 2023

Choose a reason for hiding this comment

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

А да, я отключал его. Забыл закомитить. В общем я убрал этот сайдбар справа

Copy link
Member Author

@perastov perastov Oct 7, 2023

Choose a reason for hiding this comment

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

Здесь выявилось, что readthedocs свою рекламу транслирует в документации. Но это внизу страницы на панели слева.
image

Попробовал убрать его, но пока безрезультатно

Может забить на эту рекламу, она вроде небольшая? Или вернуть лучше прошлую тему, там вроде нет шаблона в разметке страница, чтобы реклама встраивалась.

Copy link
Member

Choose a reason for hiding this comment

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

У тебя adblock не установлен что ли? :) У меня рекламы нет.

А вообще пусть будет, почему нет, пусть readthedocs зарабатывают, доброе дело же делают, что хостят документацию.

Copy link
Member Author

Choose a reason for hiding this comment

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

На самом деле стоит=)) Она иногда появляется иногда нет. Оставляю тогда эту тему)

@perastov perastov force-pushed the fix-docs-sidebar branch 4 times, most recently from 4749c4a to 04c4686 Compare October 6, 2023 19:44
@perastov perastov force-pushed the fix-docs-sidebar branch 2 times, most recently from 008dde8 to ae057f1 Compare October 7, 2023 09:39
@perastov perastov changed the title Fix docs sidebar Change docs theme Oct 7, 2023
@perastov perastov merged commit f84d5ea into main Oct 7, 2023
1 check passed
@perastov perastov deleted the fix-docs-sidebar branch October 7, 2023 10:16
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