Skip to content
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

Sphinx documentation pipeline #8

Merged
merged 9 commits into from
May 22, 2024
Merged

Conversation

willtai
Copy link
Contributor

@willtai willtai commented Apr 10, 2024

Summary

We want to setup a pipeline such that we can generate documentation easily.

Implementation

  • Added sphinx to dev dependencies
  • Ran sphinx command to build docs locally
  • Added instructions in the docs README
  • (additional) Added a precommit hook for using ruff to format and lint as I kept running into this issue

@willtai willtai marked this pull request as ready for review April 10, 2024 09:10
@willtai willtai changed the title Sphinx documentation pipeline [Blocked] Sphinx documentation pipeline Apr 18, 2024
@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch from 4bcd425 to 030763e Compare April 29, 2024 16:27
@willtai willtai changed the title [Blocked] Sphinx documentation pipeline Sphinx documentation pipeline Apr 29, 2024
@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch from 030763e to 8361b2f Compare April 29, 2024 17:21
@willtai willtai changed the base branch from main to willtai/hybrid-cypher-retriever April 29, 2024 17:22
@willtai willtai marked this pull request as draft April 30, 2024 08:00
@willtai willtai force-pushed the willtai/hybrid-cypher-retriever branch from 7ab5cbf to e04c078 Compare April 30, 2024 09:27
Base automatically changed from willtai/hybrid-cypher-retriever to main April 30, 2024 09:39
@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch 7 times, most recently from abee944 to eda12a4 Compare April 30, 2024 13:00
@willtai willtai marked this pull request as ready for review April 30, 2024 16:05
@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch 12 times, most recently from b1065fc to cb71a96 Compare May 8, 2024 13:34
@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch from cb71a96 to 8fe574e Compare May 13, 2024 09:26
@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch 2 times, most recently from 271d1c8 to 8d69382 Compare May 20, 2024 13:41
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch 6 times, most recently from eea02aa to 87db59e Compare May 22, 2024 10:51
@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch from 87db59e to 742c306 Compare May 22, 2024 11:25
@willtai willtai requested review from oskarhane and removed request for oskarhane May 22, 2024 11:56
Copy link
Member

@oskarhane oskarhane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📜

@willtai willtai force-pushed the willtai/sphinx-documentation-pipeline branch from f688436 to 2580926 Compare May 22, 2024 13:32
@willtai willtai merged commit 767ef3b into main May 22, 2024
10 checks passed
@willtai willtai deleted the willtai/sphinx-documentation-pipeline branch May 22, 2024 15:47
willtai added a commit that referenced this pull request May 22, 2024
* Refactored retrievers into a directory with separate files

* Adds HybridCypherRetriever, refactor query construction, add tests

* Put docs/_build in gitignore

* Adding content to docs

* Edited Makefile to use poetry

* Use separate token for creating git tags in actions

* Bump version to 0.2.0a1

* Rename GitHub Action Workflow

* Missing docstring for filters argument in VectorRetriever

---------

Co-authored-by: Oskar Hane <[email protected]>
Co-authored-by: Neo4j-GenAI GitHub Action <[email protected]>
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.

3 participants