Skip to main content

A wiki generation package for the Sample Programs repo

Project description

The Sample Programs Docs Generator

The Sample Programs Wiki tool houses the wiki.py script which we use in the Sample Programs repository to generate our documentation. The script is automated by a GitHub Actions build in the Sample Programs repo.

If you would like to propose a change, feel free to leverage the issues tab or make a pull request.

How It Works

The wiki.py script works by analyzing the information in the Sample Programs repository and storing that information in objects. These objects are then used to generate various documentation pages in Markdown.

What is Automated

Currently, the script maintains our entire Sample Programs wiki.

During wiki automation, it generates 27 pages: 1 alphabet catalog and 26 alphabet pages.

The alphabet catalog contains a table with links to each alphabet page as well as metadata like the number of scripts and languages per letter. In addition, the alphabet catalog contains the total number of scripts and languages for the entire repo.

Each alphabet page contains a table which lists each language for that particular letter as well as metadata like the number of scripts per language as well as linking to articles and issues.

How to Run

At this time, the wiki generator is hardcoded for the Sample Programs repo. In order to run it, you can install it as a package using pip:

pip install jisho

After that, you'll need a copy of the Sample Programs repo:

git clone https://github.com/TheRenegadeCoder/sample-programs.git

Finally, you can build the wiki using the following command:

jisho /path/to/sample-programs/repo/archive

Alternatively, you can clone this repo to run the wiki.py script directly:

python wiki.py /path/to/sample-programs/repo/archive

Both solutions are designed to handle repo exploration from the /archive/ directory. If successful, you should begin to see print statements for the various links under test for The Renegade Coder. When finished, you'll have a /wiki/ directory next to your script which contains the wiki. Likewise, all the READMEs should be updated.

At this point, you can push the wiki directly to the Sample Programs wiki. That's it!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jisho-0.1.3.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

jisho-0.1.3-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file jisho-0.1.3.tar.gz.

File metadata

  • Download URL: jisho-0.1.3.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jisho-0.1.3.tar.gz
Algorithm Hash digest
SHA256 f84d6f4c7d16fd5a7b3848f2e3654b7493ed72a3bca52eb5c2495edd616945ad
MD5 256c03ea3dcb32e9facf507287906589
BLAKE2b-256 0f569ef895918b8a389f8d1118d3f858415c88571a5e6a899e4a42ff2492ce81

See more details on using hashes here.

File details

Details for the file jisho-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: jisho-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jisho-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0346817904e08046a1f289bf6b8911f3ad858302f96caa5d38138e69c790b83f
MD5 a892524078465f90ad76a1e28bf97b02
BLAKE2b-256 0f5d69b9684805383413c9c775946d2616039130b7abdf7f9e1547c19d592f8d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page