docテンプレート作成

[nglcobdai]

🔨 変更内容

This pull request includes significant updates to the project, focusing on adding a workflow for deploying Sphinx documentation, updating the Dockerfile, and cleaning up the project structure. The most important changes include the addition of a GitHub Actions workflow for deploying documentation, updates to the Dockerfile, and the removal of unused code.

Workflow and Documentation Deployment:

• .github/workflows/deploy-document.yml: Added a workflow for deploying Sphinx documentation to GitHub Pages. This workflow includes steps for checking out the repository, installing Docker Compose, building and starting Docker containers, building Sphinx documentation inside the container, and deploying to GitHub Pages.

Dockerfile Updates:

• Dockerfile: Updated the PYTHONPATH environment variable, added the TZ environment variable, and included steps to clear cache to free up space. [1] [2] [3]

Project Cleanup:

• README.md: Updated the project name and removed detailed setup instructions, replacing them with a reference to the official documentation.
• app/main.py, app/utils/__init__.py, app/utils/config.py, app/utils/log.py: Removed unused code and configuration related to logging and settings. [1] [2] [3] [4]

Sphinx Documentation Setup:

• docs/Makefile, docs/make.bat, docs/source/API/API.rst, docs/source/Development/Development.rst, docs/source/Installation/Installation.rst, docs/source/Quickstart/Quickstart.rst, docs/source/Version/Version.rst, docs/source/conf.py, docs/source/index.rst: Added configuration and setup files for Sphinx documentation, including instructions for development, installation, and version history. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Project Initialization:

• pyproject.toml: Updated project metadata, including the project name, version, and dependencies. [1] [2]
• src/__main__.py: Added a main script to print "Hello World!"
• src/python_template/__init__.py: Added project metadata to the __init__.py file.

💡 特筆事項

📸 スクリーンショット

✅ 解決するイシュー

• close Dockerfile更新 #25
• close ディレクトリ構成変更 #24
• close docテンプレート作成 #23

🤝 関連するイシュー