GNU-devel ELPA - devdocs

devdocs

Description
Emacs viewer for DevDocs
Latest
devdocs-0.3.0.20220107.105141.tar, 2022-Jan-07, 30.0 KiB
Maintainer
Augusto Stoffel <arstoffel@gmail.com>
Home page
https://github.com/astoff/devdocs.el
Browse ELPA's repository
CGit or Gitweb
Badge

To install this package, run in Emacs:

M-x package-install RET devdocs RET

Full description

Table of Contents

GNU ELPA MELPA

devdocs.el is a documentation viewer for Emacs similar to the built-in Info browser, but geared towards documentation obtained from the DevDocs website. The stable version is available from GNU ELPA and a development version is available from MELPA; to install, type M-x package-install RET devdocs.

135726213-683b1f7d-5502-4afa-a549-c1aedaad8519.png

Figure 1: image

To get started, download some documentation with M-x devdocs-install. This will first query https://devdocs.io for the available documents and save the selected one to disk. Once you have the desired documents at hand, call M-x devdocs-lookup to search for entries.

In any given buffer, the first call to devdocs-lookup will query for a list of documents to search (you can select more than one option by entering a comma-separated list). This selection will be remembered in subsequent calls to devdocs-lookup, unless a prefix argument is given; in this case you can select a new list of documents. Alternatively, you can set the devdocs-current-docs variable directly, say via dir-local variables or a mode hook:

(add-hook 'python-mode-hook
	  (lambda () (setq-local devdocs-current-docs '("python~3.9"))))

In the *devdocs* buffer, navigation keys similar to Info and *Help* buffers are available; press C-h m for details. Internal hyperlinks are opened in the same viewing buffer, and external links are opened as browse-url normally would.

1 Contributing

Discussions, suggestions and code contributions are welcome! Since this package is part of GNU ELPA, nontrivial contributions (above 15 lines of code) require a copyright assignment to the FSF.

Old versions

devdocs-0.2.0.20211101.155959.tar.lz2021-Nov-016.98 KiB
devdocs-0.2.0.20211002.171700.tar.lz2021-Oct-026.98 KiB
devdocs-0.2.0.20210919.104247.tar.lz2021-Sep-196.79 KiB
devdocs-0.2.0.20210818.162230.tar.lz2021-Aug-186.24 KiB
devdocs-0.2.0.20210626.134923.tar.lz2021-Jun-266.21 KiB
devdocs-0.2.0.20210618.162150.tar.lz2021-Jun-186.06 KiB
devdocs-0.1.0.20210608.162544.tar.lz2021-Jun-086.06 KiB
devdocs-0.1.0.20210603.182430.tar.lz2021-Jun-035.45 KiB
devdocs-0.1.0.20210529.215553.tar.lz2021-May-305.25 KiB
devdocs-0.1.0.20210529.193118.tar.lz2021-May-295.09 KiB