https://github.com/mcneel/docify
Generate API documentation for Rhino and Grasshopper related APIs
https://github.com/mcneel/docify
grasshopper rhino3d rhinocommon
Last synced: 5 months ago
JSON representation
Generate API documentation for Rhino and Grasshopper related APIs
- Host: GitHub
- URL: https://github.com/mcneel/docify
- Owner: mcneel
- License: mit
- Created: 2020-03-10T03:43:29.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-12T00:28:54.000Z (6 months ago)
- Last Synced: 2024-12-12T01:26:09.528Z (6 months ago)
- Topics: grasshopper, rhino3d, rhinocommon
- Language: C#
- Homepage: https://mcneel-apidocs.herokuapp.com/rhinocommon/rhino.angleunitsystem
- Size: 17.5 MB
- Stars: 5
- Watchers: 25
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docify
Project for generating Rhino/Grasshopper API documentation. This repo is split into the following parts:
# src
src contains a Visual Studio project (api_docify) that parses source code and generates markdown and json files that represent the public facing API for a project
# quasar_site
a quasar project that creates a web site based on the json files created. This site currently gets published to heroku and can be viewed at
https://mcneel-apidocs.herokuapp.com/api/rhinocommon/
Instructions for building and testing the quasar site can be found at
[quasar site readme](quasar_site/readme.md)
## Usage
```shell
$ api_docify --name=
$ api_docify --name=
```
**Example**
```shell
$ api_docify.exe --name="RhinoCommon" "%RHINO4SRC%/rhinocommon/dotnet" "src/modules/docify/quasar_site/src/RhinoCommonApi.js"
```
# VS Code (Mac) setup instructions
1. Ensure node, npm, and quasar are installed
2. Open this folder in VS Code
3. Run `CMD+Shift+P > Run Task > initial setup (npm)`
4. Run `CMD+Shift+P > Run Task > docify init`, then enter the path where the Rhino source code is located and press enter.
5. Run `CMD+Shift+P > Run Task > docify build`
5. Run `CMD+Shift+P > Run Task > run quasar`
## Troubleshooting
Some namespaces may need `methodgen` to be run on the source first before documentation can be extracted. You can do this by building Rhino from source.