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

docs: switch to sphinx_rtd_theme to match other docs #6854

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

joshtrichards
Copy link
Member

@joshtrichards joshtrichards commented Jun 28, 2024

This switches the Desktop Client Manual to the same theme used for all of our other documentation (i.e. Admin, User, Dev):

  • sphinx-rtd-theme + optional dark mode
  • unifies some misc related elements (directly copied from our other documentation):
    • custom.css
    • up-to-date logos
  • adds a requirements.txt for ease of installation of dependencies for documentation developers/contributors (this is how we do things for the other docs already)
    • e.g. pip install -r requirements.txt
  • also includes a couple tiny bug fixes:
    • a table issue in the Advanced Usage chapter that broke the inclusion of the [General] section of the Configuration File section at some point in the last release or so
    • corrects a couple build time heading length mismatch warnings

Notes:

  • I think there is an additional step (automated? manual?) in the build->deploy to production for the Desktop docs. That may need some finessing since as best as I can tell there are some other bits added outside the Sphinx build process for the production deploys that are ending up on https://docs.nextcloud.com/desktop/3.13/ (the outdated in terms of design Nextcloud heading/etc). Presumably those are no longer needed after this change (we don't use them for the other docs at least).
  • This should also make it easier to transition the docs out of the Desktop repo and over to the main documentation repo at a later date/in a follow-up if needed.

image

@nextcloud-desktop-bot
Copy link

AppImage file: nextcloud-PR-6854-2ab298e63a8334cf4c5c18a8660c7c9192c60470-x86_64.AppImage

To test this change/fix you can simply download above AppImage file and test it.

Please make sure to quit your existing Nextcloud app and backup your data.

Copy link

sonarcloud bot commented Jun 28, 2024

Copy link
Collaborator

@mgallien mgallien left a comment

Choose a reason for hiding this comment

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

the doc building CI check via drone is failing
can you have a look or tell us if you would need help ?
I fear we currently use an old docker image when compared to server documentation

@joshtrichards joshtrichards linked an issue Aug 11, 2024 that may be closed by this pull request
@mgallien
Copy link
Collaborator

@joshtrichards I am sorry for the delay
this is complicated as the build infrastructure for desktop files client is really outdated compared to the server one
I unfortunately have not much time I can allocate to this
Still it would be vert cool and valuable to merge this PR
do you feel trying yourself ?
just look at the drone "Documentation" check

@joshtrichards joshtrichards mentioned this pull request Oct 11, 2024
@joshtrichards joshtrichards linked an issue Oct 11, 2024 that may be closed by this pull request
@camilasan
Copy link
Member

this is a great update @joshtrichards, thanks!
I will try to make time to look into Matthieu's comments.

@camilasan camilasan self-assigned this Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dead doc links user manual is difficult to read
5 participants