diff --git a/docsets/RenPy_Engine/README.md b/docsets/RenPy_Engine/README.md index aceec2fc3b..c85982db48 100644 --- a/docsets/RenPy_Engine/README.md +++ b/docsets/RenPy_Engine/README.md @@ -5,41 +5,155 @@ Renpy Engine Docset Generated by [scillidan](https://github.com/scillidan) with [doc2dash](https://github.com/hynek/doc2dash). -## Environment +With `8.2.0` version, `make html` failed on Windows 10, so I make `html` on Ubuntu in [VirtualBox](https://www.virtualbox.org/). There will be some changes in Ubuntu, but you can still refer to the following manul. -Windows10 - -## Install +## Install requirements ```sh -scoop install make scoop install python39 -pip install sphinx==4.4.0 sphinx_rtd_theme==1.1.1 sphinx_rtd_dark_mode future pip install doc2dash -scoop install trash // Optional +scoop install make +scoop install trash ``` -## Start +## Make docset -Download stable-version source from https://github.com/renpy/renpy/releases. Decompress it, then: +Download stable-version from https://github.com/renpy/renpy/releases. Decompress it, then: + +```sh +cd renpy/sphinx +python39 -m venv venv +venv\Scripts\activate.bat +pip install sphinx==5.0.0 sphinx_rtd_theme sphinx_rtd_dark_mode future +``` + +Build document: ```sh -cd renpy -cd sphinx make html +``` + +Convert to docset, and name a shorter keyword for search. But don't use abbreviation, see [Docset requirements](https://github.com/Kapeli/Dash-User-Contributions/wiki/Docset-Contribution-Checklist#docset-requirements): + +```sh doc2dash --name renpy -f ./build/html -move renpy.docset RenPy_Engine.docset -wget https://raw.githubusercontent.com/Kapeli/Dash-User-Contributions/master/docsets/RenPy_Engine/icon.png -O RenPy_Engine.docset/icon.png -wget https://raw.githubusercontent.com/Kapeli/Dash-User-Contributions/master/docsets/RenPy_Engine/icon@2x.png -O RenPy_Engine.docset/icon@2x.png +``` + +Still use current name `dirname`: + +```sh +mv renpy.docset RenPy_Engine.docset +``` + +And in `RenPy_Engine.docset\Contents\Info.plist`: + +``` +CFBundleName +RenPy Engine +``` + +If you will use multiple versions, specify the version number: + +``` +CFBundleName +RenPy 8.1.3 +``` + +If you have `.svg`, `get `svg2png.exe` from [SVG to PNG converter](https://github.com/v0lt/svg2png). + +```sh +svg2png -w 16 Input.svg +svg2png -w 32 Input.svg +``` + +Put `icon.png`, `icon@2x.png` in `RenPy_Engine.docset`. + +Move `RenPy_Engine.docset` into storage directory of Zeal. + +## PR note + +Refer to [Dash-User-Contributions](https://github.com/Kapeli/Dash-User-Contributions) and [Contributions](https://github.com/MarcDiethelm/contributing). + +Fork https://github.com/Kapeli/Dash-User-Contributions. + +```sh +git clone https://github.com/YourName/Dash-User-Contributions +cd Dash-User-Contributions +``` + +Sync to `upstream`: + +```sh +git pull +``` + +Create a new branch: + +```sh +git checkout -b "renpy-engine-x.x.x" +``` + +For contribute to https://github.com/Kapeli/Dash-User-Contributions, compress directory to `.tgz`: + +```sh tar --exclude='.DS_Store' -cvzf RenPy_Engine.tgz RenPy_Engine.docset +``` + +Put `RenPy_Engine.tgz` into `...\Dash-User-Contributions\docsets\RenPy_Engine\versions\x.x.x`. + +Update `...\Dash-User-Contributions\docsets\RenPy_Engine\docset.json`: + +```sh +{ + "name": "RenPy_Engine", + "version": "x.x.x", + "archive": "RenPy_Engine.tgz", + "author": { + "name": "...", + "link": "..." + }, + "aliases": ["RenPy","Ren'Py"], + "specific_versions": [ + { + "version": "x.x.x", + "archive": "versions/x.x.x/RenPy_Engine.tgz" + }, + { + "version": "8.1.3", + "archive": "versions/8.1.3/RenPy_Engine.tgz" + } + ... + ] +} +``` + +Push to your fork: + +```sh +git add . +git commit -m "renpy-engine-x.x.x" +git push origin +``` + +Fork Repository → Sync fork → Create Pull requests → Waiting check and merge ... + +If PR be merge, re-sync to `upstream`, + +```sh +git branch -d renpy-engine-x.x.x +git push origin --delete renpy-engine-x.x.x +``` + +Clear file: + +```sh trash RenPy_Engine.docset -move RenPy_Engine.tgz .../Dash-User-Contributions/docsets/RenPy_Engine/RenPy_Engine.tgz ``` -## Feed +## Add feed -Zeal > Tools > Docsets > Add feed: +Zeal → Tools → Docsets → Add feed: ``` -dash-feed://http%3A%2F%2Fraw.githubusercontent.com%2Fscillidan%2Frepo_cos%2Fmain%2Fdocset%2FRenPy_Engine.xml +dash-feed://http%3A%2F%2Fraw.githubusercontent.com%2Fscillidan%2Fpublic_source%2Fmain%2FZeal%2FRenPy_Engine.xml ``` \ No newline at end of file diff --git a/docsets/RenPy_Engine/RenPy_Engine.tar.gz b/docsets/RenPy_Engine/RenPy_Engine.tar.gz new file mode 100644 index 0000000000..4184d15279 Binary files /dev/null and b/docsets/RenPy_Engine/RenPy_Engine.tar.gz differ diff --git a/docsets/RenPy_Engine/RenPy_Engine.tgz.txt b/docsets/RenPy_Engine/RenPy_Engine.tgz.txt deleted file mode 100644 index f091f6c19a..0000000000 --- a/docsets/RenPy_Engine/RenPy_Engine.tgz.txt +++ /dev/null @@ -1,6 +0,0 @@ -Archive "RenPy_Engine.tgz" was processed at this location, pushed to the CDN and completely removed from git. - -Date: 2023-10-24 09:22:36 +0000 -SHA1: d2178e12c6d02517e762144f2b58bbdc9c526b3a - -Note: This file is just a txt file, nothing more. It does not act as a placeholder for the original archive. Deleting, moving or renaming this file does nothing. \ No newline at end of file diff --git a/docsets/RenPy_Engine/docset.json b/docsets/RenPy_Engine/docset.json index b449d325ee..628642cbbd 100644 --- a/docsets/RenPy_Engine/docset.json +++ b/docsets/RenPy_Engine/docset.json @@ -1,10 +1,16 @@ { "name": "RenPy_Engine", - "version": "8.1.3", + "version": "8.2.1", "archive": "RenPy_Engine.tgz", "author": { "name": "scillidan", "link": "https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/RenPy_Engine" }, - "aliases": ["RenPy","Ren'Py"] + "aliases": ["RenPy","Ren'Py"], + "specific_versions": [ + { + "version": "8.2.0", + "archive": "versions/8.2.0/RenPy_Engine.tgz" + } + ] } diff --git a/docsets/RenPy_Engine/versions/8.2.0/RenPy_Engine.tgz b/docsets/RenPy_Engine/versions/8.2.0/RenPy_Engine.tgz new file mode 100644 index 0000000000..6cb4815303 Binary files /dev/null and b/docsets/RenPy_Engine/versions/8.2.0/RenPy_Engine.tgz differ