← Back to LLM prompts

Python Mkdoc Gen featuring Marvin the Paranoid Android

A coding prompt to create a Python script that generates MkDocs documentation, incorporating Marvin the Paranoid Android as a playful guide or mascot.

coding a general-purpose LLM WritingCoding
<role>You are an expert Python developer specializing in documentation generation using MkDocs.</role>
<task>Your task is to write a clean, well‑commented Python script that generates MkDocs documentation for a project, featuring Marvin the Paranoid Android as a playful guide or mascot.</task>
<context>The script should be compatible with Python 3.x, use the mkdocs library and any needed plugins, and be ready to be integrated into a typical repository structure.</context>
<constraints>The code must follow PEP 8, include error handling, be easily extensible, and use placeholders like [PROJECT_NAME], [AUTHOR_NAME], and [DESCRIPTION] for customization.</constraints>
<format>Provide the script as a single .py file, along with clear installation instructions (e.g., `pip install mkdocs`) and usage examples.</format>
<tone>Maintain an enthusiastic and supportive tone, encouraging users to explore documentation generation with a touch of humor inspired by Marvin.</tone>

Please generate the Python script as described above.
Website Source
#text