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

docs: Syncup mkdocs.yml with the current documention #4173

Merged
merged 1 commit into from
Aug 28, 2024

Conversation

rene
Copy link
Contributor

@rene rene commented Aug 28, 2024

Add recent documentation files that were not added to the mkdocs.yml.

Add recent documentation files that were not added to the mkdocs.yml.

Signed-off-by: Renê de Souza Pinto <rene@renesp.com.br>
Copy link
Member

@OhmSpectator OhmSpectator left a comment

Choose a reason for hiding this comment

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

I think we also need a README.ms in the mkdocs dir where remind on how to build the documentation =D

@OhmSpectator
Copy link
Member

@rene, I tried to run the python script in the dir, but got only this:

.
├── mkdocs.yml
├── output
│   ├── output
│   │   ├── output
│   │   │   └── requirements.txt
│   │   └── requirements.txt
│   └── requirements.txt
├── prepare_mkdocs.py
└── requirements.txt

So, still trying to figure out how to build it )))

@OhmSpectator
Copy link
Member

If I run the mkdocs tool locally, I get this

➜  mkdocs git:(fix-mkdocs) ✗ mkdocs build
ERROR    -  Config value: 'docs_dir'. Error: The path /home/nikolay/projects/pr-reviews/eve-4173/docs/mkdocs/dist/docs-src/ isn't an
            existing directory.
Aborted with 1 Configuration Errors!

@OhmSpectator
Copy link
Member

I found the solution!

python3 docs/mkdocs/prepare_mkdocs.py dist/docs-src "https://github.com/lf-edge/eve/blob/master"
cp docs/mkdocs/mkdocs.yml .
mkdocs build
mkdocs serve

Could we please add it to some doc?... Or even make it available as a Makefile target?

@OhmSpectator OhmSpectator merged commit e50fc6e into lf-edge:master Aug 28, 2024
32 of 36 checks passed
@rene rene deleted the fix-mkdocs branch August 29, 2024 10:18
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.

2 participants