Skip to content

Clean up docs/source/conf.py #3515

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.

Sign up for GitHub

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

Jump to bottom
Merged
Bibo-Joshi merged 6 commits into from
Feb 2, 2023
Merged

Clean up docs/source/conf.py #3515

Bibo-Joshi merged 6 commits into from
Feb 2, 2023

Conversation

@Bibo-Joshi
Copy link
Member

@Bibo-Joshi Bibo-Joshi commented Jan 22, 2023

Moves the different functions used for custom scripting to the new docs/auxil directly. This

  • doesn't clutter conf.py as much
  • groups the code by functionality, making it easier to maintain

@Bibo-Joshi Bibo-Joshi added the ⚙️ documentation affected functionality: documentation label Jan 22, 2023
github-actions[bot]
github-actions bot reviewed Jan 22, 2023
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey! Looks like you edited the (optional) requirements or the pre-commit hooks. I'm just a friendly reminder to keep the additional dependencies for the hooks in sync with the requirements :)

lemontree210
lemontree210 reviewed Jan 22, 2023
View reviewed changes
Copy link
Member

@lemontree210 lemontree210 left a comment

Choose a reason for hiding this comment

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

My small general concern is that all modules are in one dir, while actually only half of them are imported in conf.py while the rest is used by those three. Maybe they should me moved to a subdir.

harshil21
harshil21 reviewed Jan 24, 2023
View reviewed changes
@Bibo-Joshi Bibo-Joshi merged commit 62ab2e8 into doc-fixes Feb 2, 2023
@Bibo-Joshi Bibo-Joshi deleted the clean-up-conf.py branch February 2, 2023 18:06
@Bibo-Joshi Bibo-Joshi mentioned this pull request Feb 2, 2023
Merged
9 tasks
Bibo-Joshi added a commit that referenced this pull request Feb 5, 2023
@Bibo-Joshi @harshil21
@shivamsn97 @clot27 @lemontree210 @CrsiX @Poolitzer
Documentation Improvements (#3464, #3483, #3484, #3497, #3512, #3501, #…
9953216 
…3515, #3523,  #3498, #3529)

Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
Co-authored-by: Shivam Saini <51438830+shivamsn97@users.noreply.github.com>
Co-authored-by: Aditya Yadav <adityayadav11082@gmail.com>
Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com>
Co-authored-by: Crsi <47722349+CrsiX@users.noreply.github.com>
Co-authored-by: poolitzer <github@poolitzer.eu>
Co-authored-by: Aditya <clot27@apx_managed.vanilla>
@github-actions github-actions bot locked and limited conversation to collaborators Feb 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@harshil21 harshil21 harshil21 left review comments

@github-actions github-actions[bot] github-actions[bot] left review comments

@lemontree210 lemontree210 lemontree210 left review comments

@Poolitzer Poolitzer Awaiting requested review from Poolitzer

Assignees

No one assigned

Labels

⚙️ documentation affected functionality: documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Bibo-Joshi @harshil21 @lemontree210