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

Cleanup docs/config.py file and clarity modifications #109

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

Conversation

IParraMartin
Copy link

Hi Yannick,

I cleaned up the docs/conf.py file (#107)

I also:

  • Deleted unnecessary commenting "#"
  • Standardized the header section comments (--------header section--------)
  • More general cleanup

@YannickJadoul
Copy link
Owner

YannickJadoul commented Nov 15, 2023

Hi, @IParraMartin. Can you tell me why you did this and want merge it?
I don't immediately see the benefit; all these things (including section headers, etc) were just created by sphinx-quickstart when I ran it a couple of years ago when setting up the docs.

I actually need to dig into docs/conf.py again, as I need to further configure the new form of documentation.

@YannickJadoul
Copy link
Owner

I cleaned up the docs/conf.py file (#107)

Sorry, I actually missed this part of your comment!

My plan was actually to dig into some of the options again, and remove some unnecessary ones, probably starting from a new sphinx-quickstart. Let me get back to this PR when I get there.

@IParraMartin
Copy link
Author

Oh okay! I just thought I could help in cleaning up :) I think it looked a little better for those in need of digging in it (looks more identifiable)

@YannickJadoul
Copy link
Owner

Thanks, I appreciate the help/extra push, actually :-)

@IParraMartin
Copy link
Author

Of course!😊

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