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

DOC: Documentation for testing documentation changes does not work #28836

Open
2 tasks done
bovlb opened this issue Dec 19, 2024 · 1 comment
Open
2 tasks done

DOC: Documentation for testing documentation changes does not work #28836

bovlb opened this issue Dec 19, 2024 · 1 comment
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder

Comments

@bovlb
Copy link
Contributor

bovlb commented Dec 19, 2024

URL

https://python.langchain.com/docs/contributing/how_to/documentation/setup/

Checklist

  • I added a very descriptive title to this issue.
  • I included a link to the documentation page I am referring to (if applicable).

Issue with current documentation:

The command:

poetry install --with lint,docs --no-root

produces the output:

Group(s) not found: docs (via --with)

Idea or request for content:

No response

@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Dec 19, 2024
@Uvi-12
Copy link
Contributor

Uvi-12 commented Dec 20, 2024

I followed the errors and made some changes in the code:

Changed Code:

# Before:
langchain-core = { path = "libs/core/", develop = true, version = "^0.3.27" }

# After:
langchain-core = { path = "libs/core/", develop = true }

Added Code:

[tool.poetry.group.docs.dependencies]
sphinx = "^4.3.2"
sphinx-rtd-theme = "^1.0.0"

Then I ran poetry install --with lint,docs --no-root, which gave this error:

pyproject.toml changed significantly since poetry.lock was last generated. Run `poetry lock [--no-update]` to fix the lock file.

I followed it and ran poetry lock --no-update. After its completion, I ran poetry install --with lint,docs --no-root, and I guess it worked properly, below is an attached screenshot after running poetry install --with lint,docs --no-root (correct me if I am wrong)

Screenshot 2024-12-20 at 12 28 15 PM

Please let me know if this is a correct fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
Projects
None yet
Development

No branches or pull requests

2 participants