| Name | introligo JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | https://github.com/JakubBrzezo/introligo |
| Summary | Professional Sphinx documentation generator with intelligent auto-discovery. Automatically finds and unifies READMEs, changelogs, markdown guides, and API docs into beautifully organized documentation sites. |
| upload_time | 2025-10-24 18:41:03 |
| maintainer | None |
| docs_url | None |
| author | Jakub Brzezowski |
| requires_python | >=3.8 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
| keywords |
documentation
sphinx
rst
yaml
generator
doxygen
breathe
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Introligo - Documentation Hub
[](https://github.com/JakubBrzezo/introligo/actions/workflows/tests.yml)
[](https://codecov.io/gh/JakubBrzezo/introligo)
**Your repository's documentation, unified.** Automatically discover, organize, and combine all your docs—READMEs, Changelogs, Markdown guides, API docs—into one beautiful Sphinx site.
> **Note**: Introligo is an open-source component of the Celin Project, freely available for any project.
## The Problem
Your documentation is scattered:
- 📄 README.md in the root
- 📝 User guides in `docs/`
- 📋 CHANGELOG.md tracking history
- 🤝 CONTRIBUTING.md for contributors
- 📦 Python docstrings in code
- 🔧 Example READMEs in subdirectories
**Each file is useful, but together they're a mess.**
## The Solution: Introligo Hub
```yaml
# Create hub_config.yaml
discovery:
enabled: true
auto_include:
readme: true
changelog: true
markdown_docs: "docs/**/*.md"
```
```bash
python -m introligo hub_config.yaml -o docs -v
cd docs && sphinx-build -b html . _build/html
```
**Result:** Professional Sphinx documentation, automatically organized. ✨
## How It Works
### 1. Auto-Discovery
Introligo scans your repository and finds all documentation:
- README files (root and subdirectories)
- CHANGELOG.md
- CONTRIBUTING.md
- LICENSE
- Markdown guides
- RST files
### 2. Smart Organization
Documents are intelligently categorized:
- **Getting Started** → READMEs, installation guides
- **User Guides** → Tutorials, how-tos
- **API Reference** → Code documentation
- **About** → Changelog, contributing, license
### 3. Beautiful Output
Everything combines into a professional Sphinx site with:
- Automatic navigation (toctree)
- Searchable content
- Mobile-responsive design
- Light/dark mode
- Your choice of theme
## Quick Start (3 Steps)
### Step 1: Install
```bash
pip install PyYAML jinja2 sphinx furo
```
### Step 2: Create Configuration
Create `introligo_config.yaml` in your project root:
```yaml
index:
title: "📚 My Project Docs"
discovery:
enabled: true
auto_include:
readme: true
changelog: true
contributing: true
license: true
markdown_docs: "docs/**/*.md"
sphinx:
project: "My Project"
html_theme: "furo"
palette: "celin" # Beautiful cosmic theme
```
### Step 3: Generate
```bash
python -m introligo introligo_config.yaml -o docs_output -v
cd docs_output
sphinx-build -b html . _build/html
python -m http.server 8000 --directory _build/html
```
Open http://localhost:8000 — your docs are ready! 🎉
## Features
### 🔍 Auto-Discovery
- Finds README, CHANGELOG, CONTRIBUTING, LICENSE automatically
- Scans for markdown files by pattern
- Discovers documentation anywhere in your repo
### 🧠 Smart Categorization
- Analyzes content to determine correct section
- Keywords-based classification
- Location-aware organization
- Handles multiple READMEs intelligently
### 📚 Multi-Format Support
- **Markdown** → Converted to RST with smart link handling
- **RST** → Included natively
- **LaTeX** → Mathematical formulas
- **Text** → Literal blocks
- **Python** → Sphinx autodoc
- **C/C++** → Doxygen integration
### 🎨 Beautiful Themes
- Built-in Celin palette (cosmic colors)
- Built-in Default palette
- Custom palette support
- Furo, RTD, Alabaster themes
- Auto-generated `conf.py`
### 🎯 Flexible Configuration
- Hub Mode (automatic) - Recommended
- Classic Mode (manual control) - Power users
- Hybrid (mix both) - Best of both worlds
## Real-World Example
Here's what Introligo finds in a typical project:
```
my-project/
├── README.md → Getting Started
├── CHANGELOG.md → About
├── CONTRIBUTING.md → About
├── LICENSE → About
├── docs/
│ ├── tutorial.md → User Guides
│ ├── user-guide.md → User Guides
│ └── advanced.md → User Guides
└── src/
├── myproject/ → API Reference (autodoc)
└── examples/
└── README.md → User Guides
```
One command generates complete, organized documentation from all of this.
## Configuration Guide
### Minimal Configuration
```yaml
discovery:
enabled: true
auto_include:
readme: true
changelog: true
```
That's it! Introligo finds and organizes your READMEs and changelog.
### Recommended Configuration
```yaml
index:
title: "📚 My Project Documentation"
description: "Complete documentation hub"
discovery:
enabled: true
scan_paths:
- "."
- "docs/"
auto_include:
readme: true
changelog: true
contributing: true
license: true
markdown_docs: "docs/**/*.md"
exclude_patterns:
- "node_modules"
- ".venv"
sphinx:
project: "My Project"
author: "Your Name"
html_theme: "furo"
palette: "celin"
```
### Advanced: Mix Auto + Manual
```yaml
discovery:
enabled: true
auto_include:
readme: true
changelog: true
# Manually add API docs and custom sections
modules:
api:
title: "📖 API Reference"
module: "myproject" # Python autodoc
architecture:
title: "🏗️ Architecture"
file_includes:
- "docs/design.md"
- "docs/decisions.md"
```
## Use Cases
### ✅ Open Source Projects
**Perfect for:** Projects with established docs scattered across README files and markdown guides.
```yaml
discovery:
enabled: true
auto_include:
readme: true
changelog: true
contributing: true
license: true
```
### ✅ Python Libraries
**Perfect for:** Libraries needing API docs combined with guides.
```yaml
discovery:
enabled: true
auto_include:
readme: true
markdown_docs: "docs/**/*.md"
modules:
api:
module: "mylib" # Auto-generates API docs
```
### ✅ Documentation Migration
**Perfect for:** Moving from markdown to Sphinx.
```yaml
discovery:
enabled: true
scan_paths: ["."]
auto_include:
markdown_docs: "**/*.md" # Find everything
```
### ✅ Multi-Language Projects
**Perfect for:** C++/Python projects with Doxygen and Sphinx.
```yaml
discovery:
enabled: true
auto_include:
readme: true
doxygen:
xml_path: "build/doxygen/xml"
modules:
cpp_api:
language: cpp
doxygen_files: ["mylib.h"]
python_api:
module: "mylib"
```
## Classic Mode (For Power Users)
If you need complete control over documentation structure:
```yaml
# No discovery - manually define everything
modules:
getting_started:
title: "Getting Started"
file_includes: "README.md"
user_guide:
title: "User Guide"
parent: "getting_started"
file_includes: "docs/guide.md"
api:
title: "API Reference"
module: "myproject"
```
**When to use Classic Mode:**
- Complex hierarchical requirements
- Precise control needed
- Building docs from scratch
- Custom organization beyond categories
**Most users should use Hub Mode.**
## Installation
### Basic Installation
```bash
pip install PyYAML jinja2
```
### With Sphinx (for building docs)
```bash
pip install PyYAML jinja2 sphinx furo
```
### With C/C++ Support
```bash
pip install PyYAML jinja2 sphinx breathe
sudo apt-get install doxygen # or: brew install doxygen
```
### Development Installation
```bash
git clone https://github.com/JakubBrzezo/introligo.git
cd introligo
pip install -e .[dev,docs]
```
## Documentation
### Examples
- [Hub Example](examples/hub_project/) - Complete realistic project
- [Python Example](examples/python_project/) - Python autodoc
- [C Example](examples/c_project/) - Doxygen integration
- [LaTeX Example](examples/latex_project/) - Math formulas
- [RST Example](examples/rst_project/) - RST includes
### Guides
- [Examples Guide](examples/EXAMPLES.md) - All examples explained
- [Hub Architecture](HUB_ARCHITECTURE.md) - Technical details
- [Migration Guide](#migrating-to-hub-mode) - From Classic to Hub
## Command Line
```bash
# Generate documentation
python -m introligo config.yaml -o output/
# Preview (dry-run)
python -m introligo config.yaml -o output/ --dry-run
# Verbose output
python -m introligo config.yaml -o output/ -v
# Custom template
python -m introligo config.yaml -o output/ -t custom.jinja2
# Strict mode (fail on errors)
python -m introligo config.yaml -o output/ --strict
```
## Migrating to Hub Mode
### From Scattered Docs
If you have READMEs and markdown files:
**Before:** Multiple disconnected files
**After:** One command to unite them
```yaml
discovery:
enabled: true
auto_include:
readme: true
markdown_docs: "docs/**/*.md"
```
### From Classic Introligo
If you're using the old YAML approach:
**Before:**
```yaml
modules:
getting_started:
title: "Getting Started"
file_includes: "README.md"
changelog:
title: "Changelog"
file_includes: "CHANGELOG.md"
```
**After:**
```yaml
discovery:
enabled: true
auto_include:
readme: true
changelog: true
```
Much simpler! And you can still add manual modules.
## FAQ
### Q: Do I have to move my documentation files?
**No!** Introligo finds documentation wherever it is. READMEs, guides, and other files can stay in their current locations.
### Q: What if auto-categorization gets it wrong?
Use manual modules to override:
```yaml
discovery:
enabled: true
auto_include:
markdown_docs: "docs/**/*.md"
modules:
architecture: # Manually control this
title: "Architecture"
file_includes: "docs/architecture.md"
```
### Q: Can I customize the organization?
Yes! Use hybrid mode—auto-discover common files, manually organize complex sections.
### Q: Does it work with existing Sphinx projects?
Yes! Introligo generates RST files that work with any Sphinx setup.
### Q: What about my existing conf.py?
Introligo can auto-generate `conf.py`, but if you have a custom one, just don't enable the `sphinx` section.
## Requirements
- Python 3.8 or higher
- PyYAML >= 6.0
- Jinja2 >= 3.0
- Sphinx >= 4.0 (for building)
**Optional:**
- Breathe >= 4.0 (C/C++ documentation)
- Doxygen (C/C++ documentation)
## Contributing
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for:
- Development setup
- Running tests
- Code style
- Submitting PRs
## License
Copyright (c) 2025 WT Tech Jakub Brzezowski
Introligo is an open-source component of the Celin Project. Free for any use, commercial or non-commercial.
## Links
- **Documentation:** [Full docs](https://jakubbrzezo.github.io/introligo)
- **Issues:** [GitHub Issues](https://github.com/JakubBrzezo/introligo/issues)
- **Examples:** [`examples/`](examples/)
---
**Made with ❤️ by WT Tech Jakub Brzezowski**
*Part of the [Celin Project](https://github.com/JakubBrzezo) ecosystem*
Raw data
{
"_id": null,
"home_page": "https://github.com/JakubBrzezo/introligo",
"name": "introligo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "documentation, sphinx, rst, yaml, generator, doxygen, breathe",
"author": "Jakub Brzezowski",
"author_email": "Jakub Brzezowski <jakubbrzez@wp.pl>",
"download_url": "https://files.pythonhosted.org/packages/c5/24/730dec67014595bfc3e603292cae4ecbf601287deca2b45748410eed462b/introligo-1.1.0.tar.gz",
"platform": null,
"description": "# Introligo - Documentation Hub\n\n[](https://github.com/JakubBrzezo/introligo/actions/workflows/tests.yml)\n[](https://codecov.io/gh/JakubBrzezo/introligo)\n\n**Your repository's documentation, unified.** Automatically discover, organize, and combine all your docs\u2014READMEs, Changelogs, Markdown guides, API docs\u2014into one beautiful Sphinx site.\n\n> **Note**: Introligo is an open-source component of the Celin Project, freely available for any project.\n\n## The Problem\n\nYour documentation is scattered:\n- \ud83d\udcc4 README.md in the root\n- \ud83d\udcdd User guides in `docs/`\n- \ud83d\udccb CHANGELOG.md tracking history\n- \ud83e\udd1d CONTRIBUTING.md for contributors\n- \ud83d\udce6 Python docstrings in code\n- \ud83d\udd27 Example READMEs in subdirectories\n\n**Each file is useful, but together they're a mess.**\n\n## The Solution: Introligo Hub\n\n```yaml\n# Create hub_config.yaml\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n changelog: true\n markdown_docs: \"docs/**/*.md\"\n```\n\n```bash\npython -m introligo hub_config.yaml -o docs -v\ncd docs && sphinx-build -b html . _build/html\n```\n\n**Result:** Professional Sphinx documentation, automatically organized. \u2728\n\n## How It Works\n\n### 1. Auto-Discovery\nIntroligo scans your repository and finds all documentation:\n- README files (root and subdirectories)\n- CHANGELOG.md\n- CONTRIBUTING.md\n- LICENSE\n- Markdown guides\n- RST files\n\n### 2. Smart Organization\nDocuments are intelligently categorized:\n- **Getting Started** \u2192 READMEs, installation guides\n- **User Guides** \u2192 Tutorials, how-tos\n- **API Reference** \u2192 Code documentation\n- **About** \u2192 Changelog, contributing, license\n\n### 3. Beautiful Output\nEverything combines into a professional Sphinx site with:\n- Automatic navigation (toctree)\n- Searchable content\n- Mobile-responsive design\n- Light/dark mode\n- Your choice of theme\n\n## Quick Start (3 Steps)\n\n### Step 1: Install\n\n```bash\npip install PyYAML jinja2 sphinx furo\n```\n\n### Step 2: Create Configuration\n\nCreate `introligo_config.yaml` in your project root:\n\n```yaml\nindex:\n title: \"\ud83d\udcda My Project Docs\"\n\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n changelog: true\n contributing: true\n license: true\n markdown_docs: \"docs/**/*.md\"\n\nsphinx:\n project: \"My Project\"\n html_theme: \"furo\"\n palette: \"celin\" # Beautiful cosmic theme\n```\n\n### Step 3: Generate\n\n```bash\npython -m introligo introligo_config.yaml -o docs_output -v\ncd docs_output\nsphinx-build -b html . _build/html\npython -m http.server 8000 --directory _build/html\n```\n\nOpen http://localhost:8000 \u2014 your docs are ready! \ud83c\udf89\n\n## Features\n\n### \ud83d\udd0d Auto-Discovery\n- Finds README, CHANGELOG, CONTRIBUTING, LICENSE automatically\n- Scans for markdown files by pattern\n- Discovers documentation anywhere in your repo\n\n### \ud83e\udde0 Smart Categorization\n- Analyzes content to determine correct section\n- Keywords-based classification\n- Location-aware organization\n- Handles multiple READMEs intelligently\n\n### \ud83d\udcda Multi-Format Support\n- **Markdown** \u2192 Converted to RST with smart link handling\n- **RST** \u2192 Included natively\n- **LaTeX** \u2192 Mathematical formulas\n- **Text** \u2192 Literal blocks\n- **Python** \u2192 Sphinx autodoc\n- **C/C++** \u2192 Doxygen integration\n\n### \ud83c\udfa8 Beautiful Themes\n- Built-in Celin palette (cosmic colors)\n- Built-in Default palette\n- Custom palette support\n- Furo, RTD, Alabaster themes\n- Auto-generated `conf.py`\n\n### \ud83c\udfaf Flexible Configuration\n- Hub Mode (automatic) - Recommended\n- Classic Mode (manual control) - Power users\n- Hybrid (mix both) - Best of both worlds\n\n## Real-World Example\n\nHere's what Introligo finds in a typical project:\n\n```\nmy-project/\n\u251c\u2500\u2500 README.md \u2192 Getting Started\n\u251c\u2500\u2500 CHANGELOG.md \u2192 About\n\u251c\u2500\u2500 CONTRIBUTING.md \u2192 About\n\u251c\u2500\u2500 LICENSE \u2192 About\n\u251c\u2500\u2500 docs/\n\u2502 \u251c\u2500\u2500 tutorial.md \u2192 User Guides\n\u2502 \u251c\u2500\u2500 user-guide.md \u2192 User Guides\n\u2502 \u2514\u2500\u2500 advanced.md \u2192 User Guides\n\u2514\u2500\u2500 src/\n \u251c\u2500\u2500 myproject/ \u2192 API Reference (autodoc)\n \u2514\u2500\u2500 examples/\n \u2514\u2500\u2500 README.md \u2192 User Guides\n```\n\nOne command generates complete, organized documentation from all of this.\n\n## Configuration Guide\n\n### Minimal Configuration\n\n```yaml\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n changelog: true\n```\n\nThat's it! Introligo finds and organizes your READMEs and changelog.\n\n### Recommended Configuration\n\n```yaml\nindex:\n title: \"\ud83d\udcda My Project Documentation\"\n description: \"Complete documentation hub\"\n\ndiscovery:\n enabled: true\n scan_paths:\n - \".\"\n - \"docs/\"\n auto_include:\n readme: true\n changelog: true\n contributing: true\n license: true\n markdown_docs: \"docs/**/*.md\"\n exclude_patterns:\n - \"node_modules\"\n - \".venv\"\n\nsphinx:\n project: \"My Project\"\n author: \"Your Name\"\n html_theme: \"furo\"\n palette: \"celin\"\n```\n\n### Advanced: Mix Auto + Manual\n\n```yaml\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n changelog: true\n\n# Manually add API docs and custom sections\nmodules:\n api:\n title: \"\ud83d\udcd6 API Reference\"\n module: \"myproject\" # Python autodoc\n\n architecture:\n title: \"\ud83c\udfd7\ufe0f Architecture\"\n file_includes:\n - \"docs/design.md\"\n - \"docs/decisions.md\"\n```\n\n## Use Cases\n\n### \u2705 Open Source Projects\n**Perfect for:** Projects with established docs scattered across README files and markdown guides.\n\n```yaml\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n changelog: true\n contributing: true\n license: true\n```\n\n### \u2705 Python Libraries\n**Perfect for:** Libraries needing API docs combined with guides.\n\n```yaml\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n markdown_docs: \"docs/**/*.md\"\n\nmodules:\n api:\n module: \"mylib\" # Auto-generates API docs\n```\n\n### \u2705 Documentation Migration\n**Perfect for:** Moving from markdown to Sphinx.\n\n```yaml\ndiscovery:\n enabled: true\n scan_paths: [\".\"]\n auto_include:\n markdown_docs: \"**/*.md\" # Find everything\n```\n\n### \u2705 Multi-Language Projects\n**Perfect for:** C++/Python projects with Doxygen and Sphinx.\n\n```yaml\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n\ndoxygen:\n xml_path: \"build/doxygen/xml\"\n\nmodules:\n cpp_api:\n language: cpp\n doxygen_files: [\"mylib.h\"]\n python_api:\n module: \"mylib\"\n```\n\n## Classic Mode (For Power Users)\n\nIf you need complete control over documentation structure:\n\n```yaml\n# No discovery - manually define everything\nmodules:\n getting_started:\n title: \"Getting Started\"\n file_includes: \"README.md\"\n\n user_guide:\n title: \"User Guide\"\n parent: \"getting_started\"\n file_includes: \"docs/guide.md\"\n\n api:\n title: \"API Reference\"\n module: \"myproject\"\n```\n\n**When to use Classic Mode:**\n- Complex hierarchical requirements\n- Precise control needed\n- Building docs from scratch\n- Custom organization beyond categories\n\n**Most users should use Hub Mode.**\n\n## Installation\n\n### Basic Installation\n\n```bash\npip install PyYAML jinja2\n```\n\n### With Sphinx (for building docs)\n\n```bash\npip install PyYAML jinja2 sphinx furo\n```\n\n### With C/C++ Support\n\n```bash\npip install PyYAML jinja2 sphinx breathe\nsudo apt-get install doxygen # or: brew install doxygen\n```\n\n### Development Installation\n\n```bash\ngit clone https://github.com/JakubBrzezo/introligo.git\ncd introligo\npip install -e .[dev,docs]\n```\n\n## Documentation\n\n### Examples\n\n- [Hub Example](examples/hub_project/) - Complete realistic project\n- [Python Example](examples/python_project/) - Python autodoc\n- [C Example](examples/c_project/) - Doxygen integration\n- [LaTeX Example](examples/latex_project/) - Math formulas\n- [RST Example](examples/rst_project/) - RST includes\n\n### Guides\n\n- [Examples Guide](examples/EXAMPLES.md) - All examples explained\n- [Hub Architecture](HUB_ARCHITECTURE.md) - Technical details\n- [Migration Guide](#migrating-to-hub-mode) - From Classic to Hub\n\n## Command Line\n\n```bash\n# Generate documentation\npython -m introligo config.yaml -o output/\n\n# Preview (dry-run)\npython -m introligo config.yaml -o output/ --dry-run\n\n# Verbose output\npython -m introligo config.yaml -o output/ -v\n\n# Custom template\npython -m introligo config.yaml -o output/ -t custom.jinja2\n\n# Strict mode (fail on errors)\npython -m introligo config.yaml -o output/ --strict\n```\n\n## Migrating to Hub Mode\n\n### From Scattered Docs\n\nIf you have READMEs and markdown files:\n\n**Before:** Multiple disconnected files\n**After:** One command to unite them\n\n```yaml\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n markdown_docs: \"docs/**/*.md\"\n```\n\n### From Classic Introligo\n\nIf you're using the old YAML approach:\n\n**Before:**\n```yaml\nmodules:\n getting_started:\n title: \"Getting Started\"\n file_includes: \"README.md\"\n changelog:\n title: \"Changelog\"\n file_includes: \"CHANGELOG.md\"\n```\n\n**After:**\n```yaml\ndiscovery:\n enabled: true\n auto_include:\n readme: true\n changelog: true\n```\n\nMuch simpler! And you can still add manual modules.\n\n## FAQ\n\n### Q: Do I have to move my documentation files?\n\n**No!** Introligo finds documentation wherever it is. READMEs, guides, and other files can stay in their current locations.\n\n### Q: What if auto-categorization gets it wrong?\n\nUse manual modules to override:\n\n```yaml\ndiscovery:\n enabled: true\n auto_include:\n markdown_docs: \"docs/**/*.md\"\n\nmodules:\n architecture: # Manually control this\n title: \"Architecture\"\n file_includes: \"docs/architecture.md\"\n```\n\n### Q: Can I customize the organization?\n\nYes! Use hybrid mode\u2014auto-discover common files, manually organize complex sections.\n\n### Q: Does it work with existing Sphinx projects?\n\nYes! Introligo generates RST files that work with any Sphinx setup.\n\n### Q: What about my existing conf.py?\n\nIntroligo can auto-generate `conf.py`, but if you have a custom one, just don't enable the `sphinx` section.\n\n## Requirements\n\n- Python 3.8 or higher\n- PyYAML >= 6.0\n- Jinja2 >= 3.0\n- Sphinx >= 4.0 (for building)\n\n**Optional:**\n- Breathe >= 4.0 (C/C++ documentation)\n- Doxygen (C/C++ documentation)\n\n## Contributing\n\nWe welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for:\n- Development setup\n- Running tests\n- Code style\n- Submitting PRs\n\n## License\n\nCopyright (c) 2025 WT Tech Jakub Brzezowski\n\nIntroligo is an open-source component of the Celin Project. Free for any use, commercial or non-commercial.\n\n## Links\n\n- **Documentation:** [Full docs](https://jakubbrzezo.github.io/introligo)\n- **Issues:** [GitHub Issues](https://github.com/JakubBrzezo/introligo/issues)\n- **Examples:** [`examples/`](examples/)\n\n---\n\n**Made with \u2764\ufe0f by WT Tech Jakub Brzezowski**\n\n*Part of the [Celin Project](https://github.com/JakubBrzezo) ecosystem*\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "Professional Sphinx documentation generator with intelligent auto-discovery. Automatically finds and unifies READMEs, changelogs, markdown guides, and API docs into beautifully organized documentation sites.",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/JakubBrzezo/introligo/issues",
"Changelog": "https://github.com/JakubBrzezo/introligo/blob/master/CHANGELOG.md",
"Documentation": "https://jakubbrzezo.github.io/introligo",
"Homepage": "https://github.com/JakubBrzezo/introligo",
"Repository": "https://github.com/JakubBrzezo/introligo"
},
"split_keywords": [
"documentation",
" sphinx",
" rst",
" yaml",
" generator",
" doxygen",
" breathe"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "75ebbf90123d41b1e8e71ad6399bd881dbb7652499ab29b9d7430c820c5b1631",
"md5": "0cc2db1355da137a145e60268b2a9d63",
"sha256": "2bda5b27187bde4e06c717d41d4f29888e58a2686a35407590fe976cbc66c063"
},
"downloads": -1,
"filename": "introligo-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0cc2db1355da137a145e60268b2a9d63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 45345,
"upload_time": "2025-10-24T18:40:54",
"upload_time_iso_8601": "2025-10-24T18:40:54.603240Z",
"url": "https://files.pythonhosted.org/packages/75/eb/bf90123d41b1e8e71ad6399bd881dbb7652499ab29b9d7430c820c5b1631/introligo-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c524730dec67014595bfc3e603292cae4ecbf601287deca2b45748410eed462b",
"md5": "f18208b4e9f2dcc40281f742f2466302",
"sha256": "6a7a91114f5ba9806533935f26a50ccd9da613313e44f40351e13bd9c9ecb9e9"
},
"downloads": -1,
"filename": "introligo-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f18208b4e9f2dcc40281f742f2466302",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8903270,
"upload_time": "2025-10-24T18:41:03",
"upload_time_iso_8601": "2025-10-24T18:41:03.071403Z",
"url": "https://files.pythonhosted.org/packages/c5/24/730dec67014595bfc3e603292cae4ecbf601287deca2b45748410eed462b/introligo-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 18:41:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JakubBrzezo",
"github_project": "introligo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "introligo"
}
