https://github.com/damonoehlman/docstar

DEPRECATED: Tools for Documenting JS (and Friends) with Sphinx
https://github.com/damonoehlman/docstar

Last synced: 7 days ago
JSON representation

DEPRECATED: Tools for Documenting JS (and Friends) with Sphinx

• Host: GitHub
• URL: https://github.com/damonoehlman/docstar
• Owner: DamonOehlman
• Created: 2012-01-04T04:18:53.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2022-10-19T07:03:11.000Z (about 2 years ago)
• Last Synced: 2024-10-25T20:38:21.172Z (21 days ago)
• Language: Python
• Homepage: http://docstar.rtfd.org/
• Size: 46.9 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# docstar

Docstar is a collection of tools to assist with build great looking docs for

JS libraries.  These tools are designed to help bridge the gap between

[Sphinx](http://sphinx.pocoo.org) and current JavaScript documentation tools.

The goal is to make documenting a library a well understood and repeatable

process, which in turn makes it feel easier.  The result being that having

documentation that is easier to write and maintain, improves the quality of

documentation have a net positive effect for the whole community.

[![NPM](https://nodei.co/npm/docstar.png)](https://nodei.co/npm/docstar/)

## Other Tools

I have moved across to using [gendocs](https://github.com/DamonOehlman/gendocs)

which feels like it has less overheads.  Additionally people visit documentation

sites less than they read README files.

## License(s)

### MIT

Copyright (c) 2014 Damon Oehlman 

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.