Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a contrib/gendocs.py script for generating documentation web site #4997

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Commits on Dec 27, 2023

  1. Add a contrib/gendocs.sh script for docs gen

    Hey, I think Kakoune is a great editor!
    
    I struggled with a searchable and mobile-phone friendly documentation.
    
    Here're a Bash and Scala scripts to use the existing `**/*.asciidoc`
    for generating the static website.
    
    The code is far from ideal, but should be a good start.
    
    Would be good to improve the script and automatically publish the
    documentation using Github Actions and Pages.
    
    Hosting the draft on my personal Github pages.
    
    Here's how it looks like: https://igor-ramazanov.github.io.
    igor-ramazanov committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    cb1ceb3 View commit details
    Browse the repository at this point in the history
  2. Code review: contrib/gendocs.sh -> contrib/gendocs.py

    What: migrate from shell and Scala to pure Python.
    
    Why: to improve the UX as users likely already have Python installed.
    igor-ramazanov committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    832967d View commit details
    Browse the repository at this point in the history
  3. Igor Ramazanov Copyright Waiver

      I dedicate any and all copyright interest in this software to the
      public domain.  I make this dedication for the benefit of the public at
      large and to the detriment of my heirs and successors.  I intend this
      dedication to be an overt act of relinquishment in perpetuity of all
      present and future rights to this software under copyright law.
    igor-ramazanov committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    08ccfaf View commit details
    Browse the repository at this point in the history

Commits on Dec 28, 2023

  1. contrib/gendocs.py: refactoring

    Refactoring:
    1. Generate the docs from a single Python file.
    2. Run through Blake formatter.
    3. Add links to Antora documentation pages.
    igor-ramazanov committed Dec 28, 2023
    Configuration menu
    Copy the full SHA
    7e8c430 View commit details
    Browse the repository at this point in the history