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.

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

[MAINT] use sphinx argparse to automatically render the cli arguments doc #71

Merged
merged 1 commit into from
Dec 14, 2023
Merged

[MAINT] use sphinx argparse to automatically render the cli arguments doc #71

merged 1 commit into from
Dec 14, 2023

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Dec 14, 2023 •
edited
Loading

closes #45

  • extract parser into a separate function
  • render it using sphinx argparse

Remi-Gau
Remi-Gau commented Dec 14, 2023
View reviewed changes
docs/source/conf.py
@@ -35,7 +36,6 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

was throwing a warning

Remi-Gau
Remi-Gau commented Dec 14, 2023
View reviewed changes
docs/source/contributing.md
@@ -75,7 +75,7 @@ The workflow is the same as code contributions, with some minor differences.
1. Install the `[doc]` dependencies.

```bash
pip install -e .[doc]
pip install -e '.[doc]'
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

recently learned that single quote are required for zsh users (mac users)

@codecov-commenter
Copy link

codecov-commenter commented Dec 14, 2023 •
edited
Loading

Codecov Report

Merging #71 (a0ef5d8) into main (35e9756) will increase coverage by 0.05%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #71      +/-   ##
==========================================
+ Coverage   91.31%   91.37%   +0.05%     
==========================================
  Files           9        9              
  Lines         449      452       +3     
==========================================
+ Hits          410      413       +3     
  Misses         39       39
Files Coverage Δ
giga_connectome/run.py 96.15% <100.00%> (+0.50%) ⬆️

htwangtw
htwangtw approved these changes Dec 14, 2023
View reviewed changes
Copy link
Collaborator

@htwangtw htwangtw left a comment

Choose a reason for hiding this comment

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

thanks a bunch!

@htwangtw htwangtw merged commit a590c31 into bids-apps:main Dec 14, 2023
13 checks passed
@Remi-Gau Remi-Gau deleted the argparse branch December 14, 2023 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@htwangtw htwangtw htwangtw approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

use sphinx argparse to keep CLI doc up to date
3 participants
@Remi-Gau @codecov-commenter @htwangtw