obstschale / octave-docset

Octave documentation as Dash docset

Octave docset

Key	Value
Author	Hans-Helge Buerger
Current Octave Version:	v6.4.0
Last Update:	03. November 2021
Twitter	Twitter

Octave is a programming language for matrix mathematical calculations. It is very similar to MatLab and its syntax is almost interchangable. I use Octave at university for Machine Learning and Speech Processing calculations.

Dash is an API Documentation Browser and Code Snippet Manager for Mac. If you are using Windows or Linux you probably want to have a look at Zeal which is quite similar to Dash.

Installation for Dash

Just download this docset and unzip it. To install it just double-click on Octave.docset and Dash will add this docset.

Installation for Zeal (Linux or Windows)

To manually install a docket in Zeal you need to download the docset and copy the docset-folder into %HOMEPATH%\AppData\zeal\docset\. Restart Zeal and Octave should be loaded automatically.

---

Generate docset

The docset is generated with a Python script and the original HTML documentation. To generate the docset simply clone the repository and you have to change the version variable in build.sh (check the link whether the doc version really exists). Then run ./build.sh. The script will download the docs and will create an Octave.tgz file, which is ready for a pull request for Kapeli/Dash-User-Contributions.

Requirements

sqlite3==3.8.x
beautifulsoup4==4.5.1
bs4==0.0.1

Report Bugs

Please report all bugs or issues to the original repo > Repo Issues

octave-docset's Issues

Create simpler build script

The Redux docset has a nice build script. Maybe I can adapt it for this repo.

https://github.com/epitaphmike/redux-dash/blob/master/build.sh

Contribute docsets to Dash

I've set up a repo where users can contribute docsets to Dash. You can check it out at https://github.com/Kapeli/Dash-User-Contributions. It should contain all the info you need to get started.

Docsets that are contributed in this way will appear in a separate User Contributed section under Dash's Preferences > Downloads (i.e. just like the current Ruby Gems or Cocoa Pods sections).

If you need any help with this, don't hesitate to contact me. Thank you!

Installation: documentation issue

The README.md file mentions that https://github.com/obstschale/octave-docset/archive/master.zip contains a docset file, however it rather contains the source code that then needs to be used to generate the docset.

Submit this docset to Dash

Hi,

You should submit this docset to the Dash User Contributions repo. This way, Dash users can find it directly from within Dash, under the "User Contributed" section.

Cheers

v6.1.0 Docset

Linux support

In Linux, the filesystem is case sensitive.
Therefore, octave.docset and Octave.docset refer to different folders.
I had to modify the build.sh script to correct this.

Other than that, the generated documents work well.