https://github.com/appimage/docs.appimage.org
Source code of AppImage project's documentation
https://github.com/appimage/docs.appimage.org
Last synced: about 1 year ago
JSON representation
Source code of AppImage project's documentation
- Host: GitHub
- URL: https://github.com/appimage/docs.appimage.org
- Owner: AppImage
- License: other
- Created: 2018-07-21T01:36:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-05T01:04:07.000Z (over 1 year ago)
- Last Synced: 2025-01-11T01:12:15.473Z (about 1 year ago)
- Language: HTML
- Homepage: https://docs.appimage.org/
- Size: 1.01 MB
- Stars: 42
- Watchers: 7
- Forks: 41
- Open Issues: 28
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
AppImage docs
=============
|ci_status| |cd_status|
.. |cd_status| image:: https://drone.assassinate-you.net/api/badges/AppImage/docs.appimage.org/status.svg
:alt: CD status
:target: https://drone.assassinate-you.net/AppImage/docs.appimage.org
.. |ci_status| image:: https://github.com/AppImage/docs.appimage.org/workflows/CI/badge.svg
:alt: CI status
:target: https://github.com/AppImage/docs.appimage.org/actions
This repository is the home of the AppImage project's documentation.
It is the central source of information for users of AppImage (both
users and developers).
View it at https://docs.appimage.org/.
Build
-----
This is a `Sphinx `_ project, and can be built like
any other Sphinx project (e.g., using :code:`make html`)
For less experienced users of Sphinx/Python/virtualenv etc., a convenience script that sets up a local isolated Sphinx environment is included. It's a transparent wrapper for the :code:`Makefile`, and can be used as a drop-in replacement :code:`./make.sh html`.
For development (i.e., writing documentation), `sphinx-autobuild `_ has been integrated into the build system, which sets up a live-reloading webserver that rebuilds the site on changes and reloads the page in the browser automatically. You can use it by running :code:`./make.sh watch`.