Skip to main content

DociPy v2.1.1

Project: DociPy
Version: 2.1.1
OS: OS Independent
Author: Irakli Gzirishvili
Mail: gziraklirex@gmail.com

DociPy is a Python command-line interface application. DociPy is designed to easily generate impressive static HTML documentations

Installation

To use DociPy, follow these steps:

  1. Run this CLI command to install the Python module pip install docipy
  2. Navigate to any directory containing markdown folder/files.md
  3. Open the CLI in the selected directory and run this command docipy render
  4. Update the documentation logo at assets/logo.ico and the author image at assets/author.png
  5. Run docipy version to upgrade the version number, or docipy version (number) to set it manually

Do not change the file names in the assets folder, but feel free to update the files if needed

Output

The output will consist of 2 folders and 3 files in the root directory by default:

  • assets: A folder containing all required resources
  • version: A folder reserving previous versions
  • index.html: The generated static HTML file
  • menu.yaml: The generated menu file, which you can adjust
  • robots.txt: File that controls the behavior of search engines

The menu is mapped according to the directory tree. After adjusting your menu, don't forget to run this CLI command again docipy render to update your documentation Change the *circle to any Bootstrap icon *name in the menu.yaml file that you think fits the topic

To reset the menu, simply run the following CLI command: docipy render -r

Config

If you want to update any configuration parameters that were defined during the initial generation of the documentation:

  1. Run this CLI command to start updating configuration parameters docipy reform
  2. Skip parameters by pressing Enter to leave their values unchanged
  3. Enter new values for any desired parameter and press Enter

Config parameters will be updated as you finish filling out the required fields

These are the configuration parameters requested during the initial generation of the documentation:

  • Project: Name of the project required
  • Version: Version of the project required
  • Slogan: Slogan of the project
  • Description: Description of the project
  • Keywords: Keywords for search engines
  • Documentation URL: URL of the live documentation domain
  • Author: Author of the project required
  • Position: Author's position
  • Email: Author's email address required
  • LinkedIn: Author's LinkedIn profile URL
  • X: Author's X account URL
  • Button 1 Name: Name of the first main button
  • Button 1 Link: URL for the first main button
  • Button 2 Name: Name of the second main button
  • Button 2 Link: URL for the second main button
  • Main Color: Main color for the documentation
  • Dark Color: Darker variant of the main color for the documentation
  • Google Tag (script): Google tag script for analytics
  • Copyright Verification (meta): Meta tag for copyright verification
  • Copyright Badge (a, script): Link and script for the copyright badge

Publish

Don't forget to update the Documentation URL before publishing:

  1. Run this CLI command to start updating configuration parameters docipy reform
  2. Skip other parameters by pressing Enter to leave their values unchanged
  3. Enter Documentation URL value e.g https://example.com and press Enter

For local versions, the Documentation URL must be specified as a dot .

Metadata

Release files for docipy 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docipy 2.1.1
File Size Uploaded Provenance Actions
docipy-2.1.1.tar.gz 307.3 kB Without provenance Details for docipy-2.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for docipy 2.1.1
File Interpreter ABI Platform Actions
docipy-2.1.1-py3-none-any.whl Python 3 none any Details for docipy-2.1.1-py3-none-any.whl

Total release size: 612.1 kB

Release files / docipy-2.1.1.tar.gz

Download URL docipy-2.1.1.tar.gz
Size 307.3 kB
Tags Source
SHA-256 checksum
How to use checksums
41539c71035f4337ecc6948ef304fa3f04ca06da07689b1cd28b38d95c6a35ed
BLAKE2b-256 checksum
How to use checksums
c60786b1991d91f76ded8bd09314a54d8a819775ed903c9195671b2280feee28
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / docipy-2.1.1-py3-none-any.whl

Download URL docipy-2.1.1-py3-none-any.whl
Size 304.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
22046c2fee791321184ab5ccf4934882c8fa11f80aa61105dcae89ce2b9ec4e4
BLAKE2b-256 checksum
How to use checksums
a4980b36d18ff8626e5a09f6e7fda312dc10baaa6a4cebbb9b7a9a57cba19d3f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Security for docipy 2.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page