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.

Sign up for GitHub

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

Jump to bottom

Fix docs dependency mkdocs-mermaid-plugin #776

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix docs dependency mkdocs-mermaid-plugin #776

wants to merge 3 commits into from

Conversation

gl3nng0uld
Copy link

@gl3nng0uld gl3nng0uld commented Jan 15, 2025 •
edited
Loading

Proposed changes

Hi, I tried to build the documentation of the project from source.

However, after I set up the development environment and I run the command mkdocs serve, I got:

INFO    -  Building documentation... 
ERROR   -  Config value: 'theme'. Error: Unrecognised theme name: 'material'. The available installed themes are: mkdocs, readthedocs 
ERROR   -  Config value: 'markdown_extensions'. Error: Failed loading extension "pymdownx.superfences". 
ERROR   -  Config value: 'plugins'. Error: The "markdownmermaid" plugin is not installed

Therefore, I first added tomte with extras docs (as in tox.ini): 4c2a3ed

Then, after rerunning mkdocs serve, I got:

ERROR   -  Config value 'plugins': The "markdownmermaid" plugin is not installed

Aborted with a configuration error!

So I added mkdocs-mermaid-plugin in Pipfile: 35c8250
I used the same command occurring in tox.ini, except that now it points to a specific commit, which is a more robust approach instead of pointing to the default branch, see 44edcc9

Fixes

If it fixes a bug or resolves a feature request, be sure to link to that issue.

Types of changes

What types of changes does your code introduce to agents-aea?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

Put an x in the boxes that apply.

  • I have read the CONTRIBUTING doc
  • I am making a pull request against the develop branch (left side). Also you should start your branch off our develop.
  • Lint and unit tests pass locally with my changes and CI passes too
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that code coverage does not decrease.
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

no

@gl3nng0uld
docs: add extras 'docs' in tomte dev dependency
4c2a3ed
@gl3nng0uld
chore: update revision in tox.ini for mkdocs-mermaid-plugin repo
44edcc9 
Before this commit, there was no revision identifier in the installation command
for the package mkdocs-mermaid-plugin in the 'docs' and the 'docs-serve' tox
testenvs. However, it is good practice to point to a specific commit rather than
the default branch, whose content could change without notice.

This commit adds the revision to the URL pointing to the mkdocs-mermaid-plugin
GitHub repository. In particular, this commit adds 'abf1439' at the end of the
URL of the GitHub repository of the package. The URL to the commit is:

  pugong/mkdocs-mermaid-plugin@abf1439

The change is applied in both 'docs' and 'docs-serve'.
@gl3nng0uld
chore: add mkdocs-mermaid-plugin dev dependency in Pipfile
35c8250
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@gl3nng0uld