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

Styling updates/fixes to docs site #1005

Open
3 tasks
wren opened this issue Jul 18, 2020 · 3 comments
Open
3 tasks

Styling updates/fixes to docs site #1005

wren opened this issue Jul 18, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation 📌 This can't go stale ready for pr Okay to start work. Feel free to ask questions.

Comments

@wren
Copy link
Member

wren commented Jul 18, 2020

Documentation Change

After #1004 is merged, we should look over jrnl.rtfd.io to check for any readthedocs-specific css changes/fixes that might be needed.

Affected Page(s)

What Could Be Better?

From what I could see in my early testing, here are a few things that already need fixing:

  • "Read the Docs" bar is floating on right, instead of being nestled at the bottom of the sidebar (on the left)
  • The little ad box in the sidebar might be pushed off the screen?
  • The menu in the sidebar doesn't expand sub-menu items (this is also already a problem on jrnl.sh)

Other Information

There might be more things. We should do a sweep of the whole docs site and point out any other issues we find in this thread.

@wren wren added 🆕 New! documentation Improvements or additions to documentation labels Jul 18, 2020
@wren
Copy link
Member Author

wren commented Jul 26, 2020

I got an answer from RTD support about the index page problem:

Hi Jonathan,

Thanks a lot for the explanation. Now, it's super clear the problem and I can confirm this is a Read the Docs issue.

We have been doing some magic to autogenerate a conf.py on Sphinx and README.rst or index.md on MkDocs when we detected the project was not fully configured to allow users to jump into the platform really quick. Now, this is bringing us some incompatibilities / issues with more advanced users with some customizations. In your case, you have a index that does not come from index.md but from a HTML file. So, Read the Docs detects there is no index.md and creates one for you --but you don't want that :)

We have some issues opened for this already and there is a PR to remove this magic as well:

https://github.com/readthedocs/readthedocs.org/issues/2483​
https://github.com/readthedocs/readthedocs.org/pull/5609
https://github.com/readthedocs/readthedocs.org/issues/1800​

However, we didn't have the time to make it review, make some design decisions and keep everything working without backwards compatibilities.

I just opened a new PR that adds a Feature flag to avoid this behavior of creating an index file that we could enable in your project to make it work as you want. I was able to build your documentation with your custom index by using my local RTD development instance with your project and this flag.

You can subscribe to that PR at readthedocs/readthedocs.org#7305 to follow the discussion.

Regards,
Manuel Kaufmann
Read the Docs

@wren wren removed the 🆕 New! label Aug 8, 2020
@stale
Copy link

stale bot commented Oct 7, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Inactive issue: will be closed soon if no activity label Oct 7, 2020
@micahellison micahellison added the 📌 This can't go stale label Oct 10, 2020
@stale stale bot removed the stale Inactive issue: will be closed soon if no activity label Oct 10, 2020
@micahellison micahellison added the ready for pr Okay to start work. Feel free to ask questions. label Sep 3, 2022
@micahellison
Copy link
Member

I think this fits in this issue:

  • Fix the !!! note style (as seen in the External Editors page), which doesn't have a very distinct background so it's hard to tell when a "Note" ends.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 📌 This can't go stale ready for pr Okay to start work. Feel free to ask questions.
Projects
None yet
Development

No branches or pull requests

2 participants