autokey_documentation_exploration.md

AutoKey documentation exploration

1. Clean the trash:

   rm -rf ~/.local/share/Trash/*

2. Update the system:

   sudo apt update

3. Install the dependencies:

   sudo apt install -y git python3-pip python3-venv zip

4. Create the clones directory:

   mkdir ~/clones

5. Navigate to the clones directory:

   cd clones

6. Clone the repositories as siblings:

   git clone https://github.com/autokey/autokey.git && git clone https://github.com/autokey/autokey.github.io.git

   ...or...

   git clone https://github.com/autokey/autokey.git && git clone --branch develop --single-branch https://github.com/autokey/autokey.github.io.git 

7. Create a venv:

   python3 -m venv --system-site-packages .venv

8. Activate the venv:

   source .venv/bin/activate

9. Navigate to the documentation directory:

   cd autokey.github.io

10. Install the core packages:

    pip install pyasyncore pyinotify python-xlib -r requirements.txt

11. Generate the local documentation:

    make clean html

12. Check the links:

    make linkcheck

13. Preview the documentation in your browser:

    xdg-open _build/html/index.html 2>/dev/null

14. See if everything was excluded properly:

    sphinx-build -b dummy . _build/dummy -vvv | grep -i "considering"

    • You pass the test if:
      • No .DS_Store files show up as considering.
      • No Thumbs.db files show up as considering.
      • No autokey/ files show up.
      • No guides/ files show up.

15. Navigate to your home directory:

    cd

16. Activate the venv:

    deactivate

17. Delete the clones directory:

    rm -rf ~/clones/