andreiborisov / dash-fish

📖 Generate a Dash docset for the fish shell

dash-fish

dash-fish is a toolchain for the generation of a Dash docset for the fish shell. It uses Sphinx to build HTML documentation from the source and Dashing to generate the docset from it.

Installation

Clone the repo with git:

git clone [e-mail]:andreiborisov/dash-fish.git

System requirements

Install the dependencies with Homebrew (recommended):

brew bundle

Not using Homebrew?

---

dash-fish requires:

• git 2.24+
• git filter-repo 2.26+
• Sphinx 3+
• Dashing 0.4+

Usage

To generate the docset, run:

make build

This produces both the fish.docset itself and its archived version for submitting it to Dash user contributions.

---

dash-fish integrates docs source from fish shell repo in order to customise the Sphinx build by stripping out unnecessary elements.

To grab fresh commits from the upstream run:

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:

git rebase fish-shell main
make build

To clean the working directory from build artifacts, run:

make clean

License

dash-fish is licensed under the MIT License.

fish shell docs and icon are licensed under the GNU General Public License, version 2.