Comments (3)
Similar to scikit-learn, I think we should have a typical API reference documentation (auto-generated from doctrings) and a user guide (including various demos).
Regarding the API reference, each doctring should follow a standard format like Numpy and include a description, the inputs, the outputs and some examples.
The HTML is easily generated by Sphinx from reStructuredText code or MarkDown. Then we can import Sphinx docs to Read the Docs.
from raytracing.
I think this issue should be merged with #30
from raytracing.
+1 for the use of Sphinx from reStrcutu. I think it is the conventionnal and most robust way to produce documentation in python since the guidelines are clear in the doc. I don't think it should be a difficult choice.
from raytracing.
Related Issues (20)
- The grin lens should read the wavelength from the ray HOT 1
- Version check should be more forgiving
- The imaging condition (B=0) can probably be generalized to B/A -> 0 HOT 1
- Gaussian Beam: unit inconsistency within print description HOT 4
- Mirrors? HOT 3
- Displaying a path twice will fail
- UnboundLocalError: local variable 'fanAngle' referenced before assignment HOT 1
- Is there a possibility to implement a Diffraction grating element? HOT 1
- Example code produces error HOT 2
- Whether gridmap() or trace3d() exists in any version of Package raytracing?
- CurvedMirrors are drawn incorrectly HOT 2
- Make a function to get all achromatic doublet lenses HOT 1
- Axial ray is blocked even though it should not. HOT 1
- GRIN HOT 1
- Removing intermediate images HOT 1
- drawWaist gone ? HOT 3
- Adjust dimensions for small lens radii
- Matplotlib update to checkBoxes HOT 2
- At some point in time, something broke the Principal planes, EFF, BFF, FFL, display on achromat lenses HOT 2
- hasFieldStop() crashes under certain circumstances
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 raytracing.