Skip to content

Add live preview server and file watching features; update resolve fe… #19

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

Merged
merged 1 commit into from
Mar 9, 2025

Conversation

Himasnhu-AT
Copy link
Owner

Fixes #6

This pull request introduces several new features and improvements to the documentation generator, including watch mode, a live preview server, and enhancements to the documentation parsing logic. The most important changes are grouped by theme below:

New Features:

  • Added watch mode for automatically regenerating documentation on file changes and a live preview server with auto-reload for HTML documentation. (README.md, docu/cli.py)

CLI Enhancements:

  • Introduced new command-line arguments: --watch, --serve, --port, --host, and --files to support the watch mode and live preview server functionalities. (docu/cli.py)

Documentation Parsing Improvements:

  • Improved the logic for identifying and processing module-level and node-level documentation comments, including better handling of AST nodes and their line ranges. (docu/parsers.py)

Template Enhancements:

  • Modified the default HTML template to ensure proper formatting of documentation content by adding white-space: pre-line to the .doc class. (docu/templates/default.html)

Script Updates:

  • Updated the serve.sh script to include setup steps and start the live preview server. (scripts/serve.sh)

Copy link

vercel bot commented Mar 9, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docu ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 9, 2025 4:28pm

@Himasnhu-AT Himasnhu-AT merged commit bb84ccf into main Mar 9, 2025
3 checks passed
@Himasnhu-AT Himasnhu-AT deleted the Himasnhu-AT/issue6 branch March 9, 2025 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Watch Mode
1 participant