https://github.com/thindil/robodocset
Generate Docsets from the ROBODoc generated documentation
https://github.com/thindil/robodocset
docset documentation robodoc
Last synced: 10 months ago
JSON representation
Generate Docsets from the ROBODoc generated documentation
- Host: GitHub
- URL: https://github.com/thindil/robodocset
- Owner: thindil
- Created: 2019-08-27T07:46:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-02T04:58:09.000Z (about 6 years ago)
- Last Synced: 2025-06-11T11:23:44.656Z (about 1 year ago)
- Topics: docset, documentation, robodoc
- Language: Python
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Robodocset is a simple Python script which allow to generate [Docset](https://kapeli.com/docsets)
from [Robodoc](https://rfsber.home.xs4all.nl/Robo/) generated documentation.
This script is available under MIT license.
## Setting
Before you start, you will probably need to tweak script. Open it in any editor
and go to `types` definition. Key is part of file name to search for the
documentation entries. Value is type of Docset entry which will be added to
the index. Thus `"subprograms": "Function"` means search the file
*robo_subprograms.html* for documentation entries and add them as a
*Function* type of entries. For example, if you have file *robo_enums.html* and
you want add entries from there as *Enum* then add to this dictionary that
line:
`"enums": "Enum"`
All supported types of documentation you can find on Docset page.
## Usage
The script require to work two arguments: first argument is a name of Docset
which will be generated and second is path (absolute or relative) to the
directory which contains ROBODoc generated documentation. Thus, generating
Docset from the documentation in *docs* directory and with name *SomeDoc* will
be looking that:
`./robodocset.py SomeDoc docs`
## After generation
The script of course can't generate icons for the docset. Additionally, you
may need to edit generated file *Info.plist* and add *docset.json* file in main
directory of the generated Docset.
----
And the standard footer :)
That's all for now, and probably I forgot about something important ;) Feel
free to open Issue if you been have any question or problems with this script.
Bartek thindil Jasicki