huggingface / huggingface/doc-builder

documentation contribution, i got error running server

Open
#545 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
144
Forks
59
Avg merge
2d 5h
Merged PRs (30d)
13

Description

after install smolagents prepare for document contribution below

```
pip install -e .
pipenv install git+https://github.com/huggingface/doc-builder@main
pipenv install watchdog
```

when i try to run these command,
```
doc-builder build smolagents docs/source/en/ --build_dir ~/tmp/test-build.
doc-builder preview smolagents docs/source/en/
```

i got error

```
raise type(e)(f"There was an error when converting {file} to the MDX format.\n" + e.args[0]) from e
ValueError: There was an error when converting docs/source/en/reference/agents.md to the MDX format.
Unable to find AzureOpenAIServerModel in smolagents. Make sure the path to that object is correct.
```

Can you advise how to fix?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.