mepowerleo10/docoloco

A Dash Docs and Man pages browser for linux, built using GTK4 and Libadwaita

DocoLoco: ZealDocs and Man pages browser

DocoLoco is a versatile documentation browser that utilizes documentation sets provided by Zeal Docs and also allows browsing Linux Man pages. Please note that Zeal must be installed to use DocoLoco.

Table of Contents

• Preview
• Installation
• Running the Project
• Linux Dependencies
• Development
• Contributing
• Thanks To

Preview

Here are some preview images of DocoLoco in action:

Homepage	Documentation	Tabs Overview

Search	Dash DocSets	Man Pages

Browsing Man Pages

Installation

Manual Installation

To get started with DocoLoco, follow these steps:

1. Clone the Repository:

   git clone https://github.com/your-username/DocoLoco.git
   cd DocoLoco

2. Install Poetry:

   If you haven't installed Poetry, you can do so using the following:

   curl -sSL https://install.python-poetry.org | python3 -

   Or refer to the official Poetry installation guide for more options.

3. Install Dependencies:

   Use Poetry to install project dependencies:

   poetry install

   This will create a virtual environment and install all the necessary packages.

4. Install Zeal:

   Ensure that Zeal is installed on your system. You can download Zeal from https://zealdocs.org/.

Flatpak Version Installation

1. Clone the Repository:

   git clone https://github.com/your-username/DocoLoco.git
   cd DocoLoco

2. Install Poetry:

   If you haven't installed Poetry, you can do so using the following:

   curl -sSL https://install.python-poetry.org | python3 -

   Or refer to the official Poetry installation guide for more options.

3. Install Zeal:

   Ensure that Zeal is installed on your system. You can download Zeal from https://zealdocs.org/.

4. Install the Flatpak package

   Run the following command to install the flatpak command:

   flatpak-builder build-dir io.github.mepowerleo10.DocoLoco.yaml --install --user --force-clean 
   

   That's it! You can find the app in you apps menu now. Or run this command to open it from the command line:

   flatpak run io.github.mepowerleo10.DocoLoco.Devel
   

Release Package Installation

1. Download the Release Artifacts:

   From the releases section, download the docoloco archive

2. Extract the archive: Extract the archive, and open the extracted folder

3. Choose your installation method:

   • For flatpak installations run the command:

     chmod +x install-flatpak.sh && ./install-flatpak.sh
     

   • For Python installations run the command:

     pip3 install --prefix=./dist docoloco-0-py3-none-any.whl
     

Running the Project

Now that you have the project and its dependencies installed, you can run DocoLoco using the following steps:

1. Add Documentations: Add the docsets you need using Zeal. The DocSets will automatically be populated by the application.

2. Activate the Virtual Environment:

   Activate the virtual environment created by Poetry:

   poetry shell

3. Run DocoLoco:

   Execute the main script or entry point of DocoLoco:

   python docoloco.py

   This will launch the documentation browser.

Linux Dependencies

If you are on a Linux system, make sure you have the GTK4 development libraries installed. The application also uses mandoc to parse and generate HTML pages for manpages. You can install them using the package manager for your distribution:

• Ubuntu/Debian:

  sudo apt-get install libgtk-4-dev mandoc

• Fedora:

  sudo dnf install gtk4-devel mandoc

• Arch Linux:

  sudo pacman -S gtk4 mandoc

  Adjust the package names according to your distribution.

Development

For GTK4 completion in Python, it's recommended to use FakeGir. FakeGir provides stubs for missing GObject Introspection (GIR) files, enabling better code completion and type hinting in Python IDEs.

To install FakeGir, use the following:

pip install fakegir

After installing FakeGir, run it to generate the necessary stubs for GTK4:

fakegir --all

This will create the required files for GTK4 completion in your development environment.

Contributing

If you would like to contribute to DocoLoco, please follow our Contribution Guidelines.

Thanks To

• DASH contributing the DocSets
• Zeal providing access to Dash Docsets
• RTFM by @hugopol for the inspiration and serving as the basis for understanding the structure of a GTK application.

License

DocoLoco is licensed under the MIT License.