search

DeepRegNet / DeepReg

Medical image registration using deep learning
Apache License 2.0
564 stars 76 forks source link

Use automated docs for argparse #700

Closed mathpluscode closed 3 years ago

mathpluscode commented 3 years ago

Subject of the documentation

As shown here, https://sphinx-argparse.readthedocs.io/en/stable/sample.html#example-documentation-structure

we can create doc page from the docstring directly, so that we do not have to maintain docs in two separate places.

@NMontanaBrown the efforts you've made will be moved into one place ^^ if you are ok

NMontanaBrown commented 3 years ago

@mathpluscode can you elaborate on "the efforts I've made will be moved into one place if I am ok"? Don't understand what this is referring to.

mathpluscode commented 3 years ago

@mathpluscode can you elaborate on "the efforts I've made will be moved into one place if I am ok"? Don't understand what this is referring to.

On I mean I will not simply delete the existing page and entirely use the autodoc, I will try to keep the existing docs as much as possible.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.