Comments (10)
from monai.
I forked this repo and created the document of MONAI API here. It was built by Sphinix, and github.io automatically pulls master branch /docs folder into repository's github pages. I tried to avoid pollute this repo, so once that page looks OK, I will create a PR.
There are at least three sub-tasks in this tasks.
- Creating source RST files. Usually, they are tutorials, examples, and user guides.
- Running sphinx's document build process to generate API document from docstring, and build html files from the combination of API document and RST files.
- Publishing the html files to some document website (github.io, currently).
For current stage, we are doing most of them manually. In the future, we would like to automate them as part of CD.
from monai.
@IsaacYangSLA maybe it is possible to use pytorch CPU only to build the docs which takes < 100mb
from monai.
Copying in the initial email for complete issue history; hope that's ok.
Hi Ben,
This item was assigned to you and me. If you don’t mind, I can start and put together a proposal based on what we did before.
Let me know if this is okay with you.
Thanks,
Yan
from monai.
I don't have experience with python doc generation; do you have some go to tools for it?
from monai.
If I could put my 2 cents to this issue. In PyTorch, Torchvision (and Ignite) they are using Sphinx for docs generation. For example, for torchvision:
- https://github.com/pytorch/vision/tree/master/docs
- Makefile can be left as is (replacing the project name) and conf.py should be adapted to your project.
- main page is https://github.com/pytorch/vision/blob/master/docs/source/index.rst
make html
builds the documentation
Documentation pages are written in reStructured Text formats. Docstrings are as mentioned in the first message are in Google style.
HTH
from monai.
from monai.
Isaac to investigate Readthedocs service.
from monai.
ReadTheDocs limits memory to 1GB. However, pytorch package is around 800MB, which exceeds the memory size. With some mocked packages, I managed to build all pages and pushed them to https://monai-readthedocstest.readthedocs.io/en/latest/. The process required manually creating mocked packages/classes/functions, and did not scale well. Please take a look at https://gitlab.com/project-monai/readthedocstest/-/tree/master for those mocked codes.
from monai.
fixed via #68.
from monai.
Related Issues (20)
- connected component analysis to return components individually
- RandSpatialCropSamplesd and other transforms in the OneOf combination will have this problem HOT 1
- Get an error when reading dicom segmentation HOT 3
- Renaming `include_background`
- tests.ngc_bundle_download
- 2D Slice Segmentation with UNet from 3D Volume HOT 1
- Get error when reading dicom series with itk backend
- Incorrect spacing is recorded when reading single pydicom dataset object with pydicom
- test_tciadataset
- Improve Converting to Torchscript HOT 1
- test_keep_largest_connected_component
- Bundle Specification Needs Required Packages HOT 1
- Smooth interpolation transform for multi-label images HOT 3
- Make the Affine 32 Again HOT 2
- Bundle download failed HOT 1
- init_bundle Should Put License File in `docs` HOT 2
- sincos Positional Embedding
- `Lazy=True` ignored when using `Dataset` call
- better error message when bundle config expression has errors
- Pyinstaller error HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from monai.