Skip to content

Conversation

@gigony
Copy link
Collaborator

@gigony gigony commented Sep 8, 2021

  • Add initial document setup with Sphinx
  • Initial code update to fix Sphinx build error
  • Update run script - gen_docs/gen_docs_dev command

Building the documentation

MONAI's documentation is located at docs/.

./run gen_docs  # '-h' for help

The above command builds HTML documents in the dist/docs folder, they are used to automatically generate documents in https://docs.monai.io.

To test HTML docs locally with development server, execute below command:

./run gen_docs_dev  # '-h' for help

The above command launches a live server to build docs in runtime.

Before submitting a pull request, it is recommended to:

closes #34

@gigony gigony added the documentation Improvements or additions to documentation label Sep 8, 2021
@gigony gigony added this to the v0.1.0 milestone Sep 8, 2021
@gigony gigony force-pushed the setup_sphinx branch 3 times, most recently from 2631122 to 6121405 Compare September 8, 2021 07:02
@gigony gigony merged commit b621942 into main Sep 9, 2021
Copy link
Collaborator

@MMelQin MMelQin left a comment

Choose a reason for hiding this comment

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

Approved with a comment

...
...
This class checks if the given path meets the folder structure of Triton:
Copy link
Collaborator

Choose a reason for hiding this comment

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

A reference to the Triton doc would help.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh, Thank you! Will update in other PR when docstring is updated.

@gigony gigony deleted the setup_sphinx branch September 9, 2021 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Setup document system

6 participants