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

New documentation theme #43

Open
atridey opened this issue Aug 9, 2021 · 6 comments
Open

New documentation theme #43

atridey opened this issue Aug 9, 2021 · 6 comments
Assignees

Comments

@atridey
Copy link
Collaborator

atridey commented Aug 9, 2021

I was experimenting with moving the documentation from the Read The Docs Sphinx theme to the Press Sphinx theme. You can compare them at https://spotibyeads.readthedocs.io/en/latest/ and https://spotibyeads.readthedocs.io/en/press-theme/ respectively.
My personal opinion is that the press theme looks nicer, but since I have to manually scale the images (as compared to the automatic scaling on the RTD theme), the images are too small on high-resolution displays and too big on mobile and low-resolution displays. They only look as intended on a 1080p desktop monitor, which I think most people will use, but it's still something to consider.

@AnonymouX47
Copy link
Contributor

AnonymouX47 commented Aug 9, 2021

I personally think this is unnecessary, the Sphynx theme is good enough. The content is what needs focus.

@atridey atridey self-assigned this Aug 10, 2021
@WarpWing
Copy link
Contributor

I like the Press theme but I don't think it warrants an entire redesign. I think we should finalize the site(with it's content first and THEN update it)

@AnonymouX47
Copy link
Contributor

I like the Press theme but I don't think it warrants an entire redesign. I think we should finalize the site(with it's content first and THEN update it)

Exactly my point.

@atridey
Copy link
Collaborator Author

atridey commented Aug 10, 2021

Well the "redesign" isn't very hard, just a lot of copy and pasting. But I do agree that the content is more important. For now I have them on two different git branches, both of which readthedocs is hosting.

@AnonymouX47
Copy link
Contributor

just a lot of copy and pasting

I think that's unnecessary, it should be possible to make changes to the content on one branch and merge that one into the other branch to update it.
If merges will result in conflicts, then i suppose using git stash will definitely suffice.

@WarpWing
Copy link
Contributor

just a lot of copy and pasting

I think that's unnecessary, it should be possible to make changes to the content on one branch and merge that one into the other branch to update it.
If merges will result in conflicts, then i suppose using git stash will definitely suffice.

Agreed, git stash the changes and finalize the content :D

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

No branches or pull requests

3 participants