Comments (2)
Hey this sounds great. That sphinx documentation looks very nice!
I don't think I'll have time to contribute much for a while but I'll gladly accept new code. I like the idea. It should be easy enough to implement, just serialize the output of documentModule
and print to stdout. You may need to tweak docgen.coffee
to deal with multiple modules, or perhaps only allow it to document one module at a time with the --json flag.
Let me know if you get stuck, I'll be happy to help.
from coffeedoc.
Just thought I'd add that I have an initial version of this available on PyPI. To use:
pip install sphinxcontrib-coffee
and follow the instructions at http://pypi.python.org/pypi/sphinxcontrib-coffee/0.1.0
from coffeedoc.
Related Issues (20)
- No --requirejs when installed via npm, version 0.1.11 HOT 2
- DocBlock before statements (functions) HOT 3
- Participate in DocSpec HOT 1
- I built coffeedoctest from coffeedoc HOT 2
- weird stuff happens with classes defined in index.coffee HOT 3
- Does not generate html files only index.html HOT 3
- Flag to ignore files or folders HOT 3
- HtmlRenderer() has no method 'renderIndex' HOT 1
- reserved word "private" HOT 4
- Classes and Functions inside a top-level function won't be parsed HOT 5
- String literal in the beginning of the class declaration makes coffeedoc to fail HOT 3
- Hide non-public class methods from documentation HOT 1
- Class instance method not documented HOT 2
- Suggestion: headers beyond h2 HOT 1
- Ability to hide functions starting with _? HOT 2
- Class docstring is null when using tabs for indenting HOT 6
- Top-level documentation comment not parsed when preceded by another line HOT 2
- <Object> has no method 'existsSync' HOT 4
- Feature Request: Don't render AST nodes that aren't commented 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 coffeedoc.