release: v0.1.0 - documentation cleanup and PyOpenSci review preparation

Author: HzaCode

.github/ISSUE_TEMPLATE/bug_report.md

@@ -26,7 +26,7 @@ A clear and concise description of what actually happened.
 
 ## Environment
 
-- **OneCite Version**: [e.g., 0.0.11]
+- **OneCite Version**: [e.g., 0.1.0]
 - **Python Version**: [e.g., 3.9]
 - **Operating System**: [e.g., Windows 10, macOS 13, Ubuntu 22.04]
 - **Installation Method**: [e.g., pip, from source]

.github/workflows/publish.yml

@@ -12,10 +12,10 @@
 #     runs-on: ubuntu-latest
 #     
 #     steps:
-#     - uses: actions/checkout@v3
+#     - uses: actions/checkout@v4
 #     
 #     - name: Set up Python
-#       uses: actions/setup-python@v4
+#       uses: actions/setup-python@v5
 #       with:
 #         python-version: '3.10'
 #     

.github/workflows/tests.yml

@@ -16,10 +16,10 @@ jobs:
         python-version: ['3.10', '3.11']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 

.readthedocs.yml

@@ -6,20 +6,36 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/), and this
 
 ## [Unreleased]
 
+## [0.1.0] - 2025-02-09
+
 ### Added
 - RST documentation using Sphinx
 - Full API reference documentation
 - FAQ section with common questions
 - Contributing guidelines
 - Pre-commit hooks configuration
+- Google-style docstrings with Args/Returns for all public API functions
+- Auto-deploy documentation to GitHub Pages via CI
 
 ### Changed
 - Refactored exception hierarchy
 - Added type hints to Python API
 - Updated README examples
+- Bumped minimum Python version declaration in docs to 3.10
+- Updated CI actions to latest versions (checkout v4, setup-python v5)
+- Updated copyright year to 2024-2025
+- Fixed Documentation URL in pyproject.toml to point to GitHub Pages
+
+### Removed
+- MCP integration page and all related references
+- `.readthedocs.yml` (docs now hosted on GitHub Pages)
+- `docs/_build/` build artifacts from repository
 
 ### Fixed
 - CrossRef and Semantic Scholar response parsing edge cases
+- API documentation using incorrect return value fields (`output_content` -> `results`)
+- Version number inconsistencies across metadata files
+- Python version requirement inconsistencies in docs (3.7 -> 3.10)
 
 ## [0.0.11] - 2024-10-19
 

CHANGELOG.md

@@ -19,6 +19,6 @@ keywords:
   - arxiv
   - research
 license: MIT
-version: "0.0.11"
-date-released: "2025-08-12"
+version: "0.1.0"
+date-released: "2025-02-09"
 

CITATION.cff

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 He Zhiang
+Copyright (c) 2024-2025 He Zhiang
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -198,11 +198,12 @@ def auto_select_callback(candidates):
 result = process_references(
     input_content="Deep learning review\nLeCun, Bengio, Hinton\nNature 2015",
     input_type="txt",
+    template_name="journal_article_full",
     output_format="bibtex",
     interactive_callback=auto_select_callback
 )
 
-print(result['output_content'])
+print('\n\n'.join(result['results']))
 ```
 </details>
 

README.md

@@ -128,7 +128,10 @@ Subsubsection
     # Code block
     import onecite
     
-    result = onecite.process_references("10.1038/nature14539")
+    result = onecite.process_references(
+        "10.1038/nature14539", "txt", "journal_article_full",
+        "bibtex", lambda c: 0
+    )
 
 - Bullet list
 - Another item
@@ -156,8 +159,14 @@ Use `.. code-block::` for syntax-highlighted code:
 
     from onecite import process_references
     
-    result = process_references("10.1038/nature14539")
-    print(result['output_content'])
+    result = process_references(
+        "10.1038/nature14539",
+        input_type="txt",
+        template_name="journal_article_full",
+        output_format="bibtex",
+        interactive_callback=lambda c: 0
+    )
+    print('\n\n'.join(result['results']))
 ```
 
 ## Configuration

docs/README.md

@@ -283,12 +283,15 @@ Batch Processing
     ]
     
     result = controller.process(
-        entries=references,
-        output_format="bibtex"
+        input_content="\n\n".join(references),
+        input_type="txt",
+        template_name="journal_article_full",
+        output_format="bibtex",
+        interactive_callback=lambda candidates: 0
     )
     
-    print(f"Processed: {result['processed_count']}")
-    print(f"Failed: {result['failed_count']}")
+    print(f"Processed: {result['report']['succeeded']}")
+    print(f"Failed: {len(result['report']['failed_entries'])}")
 
 Performance Optimization
 ------------------------
@@ -298,7 +301,13 @@ Performance Optimization
 ::
 
     # Fast path for single reference
-    result = process_references("10.1038/nature14539")
+    result = process_references(
+        input_content="10.1038/nature14539",
+        input_type="txt",
+        template_name="journal_article_full",
+        output_format="bibtex",
+        interactive_callback=lambda c: 0
+    )
 
 **Batch References:**
 
@@ -329,7 +338,13 @@ Validation Errors
     from onecite import ValidationError
     
     try:
-        result = process_references("")
+        result = process_references(
+            input_content="",
+            input_type="txt",
+            template_name="journal_article_full",
+            output_format="bibtex",
+            interactive_callback=lambda c: 0
+        )
     except ValidationError:
         print("Empty input")
 
@@ -341,7 +356,13 @@ Resolution Errors
     from onecite import ResolverError
     
     try:
-        result = process_references("invalid/doi")
+        result = process_references(
+            input_content="invalid/doi",
+            input_type="txt",
+            template_name="journal_article_full",
+            output_format="bibtex",
+            interactive_callback=lambda c: 0
+        )
     except ResolverError:
         print("Could not find reference")
         print("Check identifier or try again later")
@@ -353,14 +374,20 @@ Partial Success
 
     from onecite import process_references
     
-    result = process_references(mixed_refs)
+    result = process_references(
+        input_content=mixed_refs,
+        input_type="txt",
+        template_name="journal_article_full",
+        output_format="bibtex",
+        interactive_callback=lambda c: 0
+    )
     
-    print(f"Success: {result['processed_count']}")
-    print(f"Failed: {result['failed_count']}")
+    print(f"Success: {result['report']['succeeded']}")
+    print(f"Failed: {len(result['report']['failed_entries'])}")
     
-    if result['warnings']:
-        for warning in result['warnings']:
-            print(f"Warning: {warning}")
+    if result['report']['failed_entries']:
+        for entry in result['report']['failed_entries']:
+            print(f"Failed entry {entry['id']}: {entry.get('error', 'Unknown')}")
 
 Pipeline Configuration
 ======================