Comments (2)
Hi @justusschock. Thanks for your comments.
We have improved the documentation following your comments. In the last version of the code we hope to have fixed all the Python docstrings and we have improved the description of the C++ APIs.
- We used sphinx for the Python documentation and doxygen for the C++ counterpart as you have suggested.
- We have also included a small CI for the documentation to check the build at every commit.
- For the parameter type we used the numpydoc standard.
You can find the final result of our documentation at the link: docs
Let us know if you have any other comment or request about this topic.
from rfbp.
I close the issue since the problem seems to be solved. If there are any other comments on this topic just let me know.
from rfbp.
Related Issues (5)
- LICENSE File HOT 2
- Functionality Documentation HOT 2
- Install from PyPI: numpy not found HOT 6
- CONTRIBUTING.md doesn't exist HOT 2
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 rfbp.