https://github.com/andreiborisov/dash-fish
📖 Generate a Dash docset for the fish shell
https://github.com/andreiborisov/dash-fish
dash-docset fish
Last synced: about 1 year ago
JSON representation
📖 Generate a Dash docset for the fish shell
- Host: GitHub
- URL: https://github.com/andreiborisov/dash-fish
- Owner: andreiborisov
- License: mit
- Created: 2020-05-15T03:11:23.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2021-07-07T11:31:39.000Z (almost 5 years ago)
- Last Synced: 2025-02-09T11:43:32.787Z (over 1 year ago)
- Topics: dash-docset, fish
- Language: JavaScript
- Homepage:
- Size: 3.89 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dash-fish
dash-fish is a toolchain for the generation of a [Dash](https://kapeli.com/dash) docset for the [fish shell](http://fishshell.com). It uses [Sphinx](https://www.sphinx-doc.org) to build HTML documentation from the source and [Dashing](https://github.com/technosophos/dashing) to generate the docset from it.
## Installation
Clone the repo with git:
```shell
git clone git@github.com:andreiborisov/dash-fish.git
```
### System requirements
Install the dependencies with [Homebrew](https://brew.sh) (recommended):
```shell
brew bundle
```
Not using Homebrew?
- - -
dash-fish requires:
* git 2.24+
* [git filter-repo](https://github.com/newren/git-filter-repo) 2.26+
* [Sphinx](https://www.sphinx-doc.org) 3+
* [Dashing](https://github.com/technosophos/dashing) 0.4+
## Usage
To generate the docset, run:
```shell
make build
```
This produces both the `fish.docset` itself and its archived version for submitting it to [Dash user contributions](https://github.com/Kapeli/Dash-User-Contributions).
- - -
dash-fish integrates docs source from [fish shell repo](https://github.com/fish-shell/fish-shell) in order to customise the Sphinx build by stripping out unnecessary elements.
To grab fresh commits from the upstream run:
```shell
make fetch_subtree
```
This will clone fish shell repo into a temporary folder, filter out unrelated commits and add related ones via git subtree. You can merge or rebase main branch after that and rebuild the docset:
```shell
git rebase fish-shell main
make build
```
To clean the working directory from build artifacts, run:
```shell
make clean
```
## License
dash-fish is licensed under the [MIT License](LICENSE).
fish shell docs and icon are licensed under the [GNU General Public License, version 2](https://fishshell.com/docs/current/license.html).