jrnl-org / jrnl

Collect your thoughts and notes without leaving the command line.
https://jrnl.sh
GNU General Public License v3.0
6.45k stars 522 forks source link

Styling updates/fixes to docs site #1005

Open wren opened 4 years ago

wren commented 4 years ago

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:

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 commented 4 years ago

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 https://github.com/readthedocs/readthedocs.org/pull/7305 to follow the discussion.

Regards, Manuel Kaufmann Read the Docs

stale[bot] commented 3 years ago

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.

micahellison commented 1 year ago

I think this fits in this issue: