https://github.com/Kapeli/Dash-User-Contributions

Dash repo of user contributed docsets
https://github.com/Kapeli/Dash-User-Contributions

Last synced: 7 days ago
JSON representation

Dash repo of user contributed docsets

• Host: GitHub
• URL: https://github.com/Kapeli/Dash-User-Contributions
• Owner: Kapeli
• Created: 2014-04-17T10:56:20.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T06:40:03.000Z (13 days ago)
• Last Synced: 2024-10-29T15:34:46.497Z (10 days ago)
• Language: Python
• Size: 27.4 MB
• Stars: 2,000
• Watchers: 44
• Forks: 848
• Open Issues: 196
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred-test - Kapeli/Dash-User-Contributions - Dash repo of user contributed docsets (Python)

README

        
Dash User Contributed Docsets

=======================

### Report a bug or request a docset

[Open an issue](https://github.com/Kapeli/Dash-User-Contributions/issues/new).

### Install a docset

You can install these docsets from [Dash's](https://kapeli.com/dash) Preferences > Downloads > User Contributed.

### Contribute a new docset

To contribute a docset, follow the steps below. If you get stuck at any point or have any questions, [open an issue](https://github.com/Kapeli/Dash-User-Contributions/issues). I'll help.

**Notice:** You might qualify for a **free Dash license** if you had to write your own generation script to make the docset (e.g. docsets made using doc2dash, javadocset or similar do not qualify). Please mention your email address in the pull request if you'd like to request a free license.

* Generate a docset by following the instructions at https://kapeli.com/docsets

    * Note: you can ignore the instructions regarding docset feeds. You won't need them if you plan to contribute to this repo

* Make sure your docset fulfils all the required criteria on the [Docset Contribution Checklist](https://github.com/Kapeli/Dash-User-Contributions/wiki/Docset-Contribution-Checklist) and as many of the optional ones as possible

* Check out the [Versioning Guidelines](https://github.com/Kapeli/Dash-User-Contributions/wiki/Docset-Versioning-Guidelines) to understand how docset versioning works in Dash

* Fork and clone this repo

* Set up your directory structure:

  * Copy the `Sample_Docset` folder into the `docsets` folder and rename it. Use the same name as your docset, but replace whitespaces with underscores. Note: don't add `_Docset` at the end of the name, just use the docset name (e.g. `ExtJS`) and nothing else.

  * Archive your docset using:

  ```bash

  tar --exclude='.DS_Store' -cvzf .tgz .docset

  ```

  * Copy your docset archive

    * Note: don't worry about this repo's size getting huge. As soon as your docset gets distributed to my CDN, it will get removed from the repo automatically. If your docset exceeds GitHub's file limit of 100 MB, open an issue and we'll figure out a different way to submit your docset

  * Include an `icon.png` and `[email protected]` with sizes `16x16` and `32x32` or simply delete the sample icon if you don't want an icon at all

  * Edit the docset.json file. Make sure to follow the same naming rules as the sample (i.e. your docset name should be the same as the archive name, but replace whitespaces with underscores)

  * Edit the README.md

* Submit a pull request