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

Add dark mode to documentation #58

Merged
merged 2 commits into from
Jan 17, 2025

Conversation

berk-efe
Copy link
Contributor

@berk-efe berk-efe commented Jan 15, 2025

There were following modules missing;

  • pillow
  • python-tkdnd

Also i wanted to add dark mode. There were no change on the initial theme. I have found a dark mode for the exact same theme!

sphinx-rtd-dark-mode

And added
docs/_build
to .gitignore since we do not want builds on repo.

I really liked your project btw. 😃

…added them. Also added dark mode to documentation. If i am going to work on it i really need dark mode :'D
sphinx-rtd-theme==3.0.2
pillow==11.0.0
python-tkdnd==0.2.0
Copy link
Owner

@ObaraEmmanuel ObaraEmmanuel Jan 17, 2025

Choose a reason for hiding this comment

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

Thank you for taking interest in the project. These two modules (pillow and python-tkdnd) are not required for the documentation build process and should not be included here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My bad, i saw missing dependency errors after running make html, so i thought they were a necessity

WARNING: autodoc: failed to import module 'loader' from module 'formation'; the following exception was raised:
No module named 'PIL' [autodoc.import_object]
WARNING: autodoc: failed to import module 'utils' from module 'formation'; the following exception was raised:
No module named 'PIL' [autodoc.import_object]
WARNING: autodoc: failed to import module 'dialogs' from module 'hoverset.ui'; the following exception was raised:
No module named 'tkinterDnD' [autodoc.import_object]
WARNING: autodoc: failed to import module 'widgets' from module 'hoverset.ui'; the following exception was raised:
No module named 'tkinterDnD' [autodoc.import_object]
WARNING: autodoc: failed to import module 'ui.geometry' from module 'studio'; the following exception was raised:
No module named 'PIL' [autodoc.import_object]

I will change it now.

Copy link
Owner

Choose a reason for hiding this comment

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

I see. Ideally you should have installed the main dependencies of the project which are specified in the root requirements.txt for autodoc to work.

@ObaraEmmanuel ObaraEmmanuel changed the title There were some modules missing on docs/requirements.txt. Also added dark mode to documentation! Add dark mode to documentation Jan 17, 2025
@berk-efe
Copy link
Contributor Author

I have forgot to commit .gitignore so i did that too.

Copy link
Owner

@ObaraEmmanuel ObaraEmmanuel left a comment

Choose a reason for hiding this comment

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

LGTM.

@ObaraEmmanuel ObaraEmmanuel merged commit 320e3a0 into ObaraEmmanuel:master Jan 17, 2025
8 checks passed
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