search

Orange-OpenSource / ods-mkdocs-theme

Orange Design System MkDocs Theme provides a MkDocs theme for Orange
https://orange-opensource.github.io/ods-mkdocs-theme/
MIT License
6 stars 1 forks source link

feat: add sample directory #9

Open julien-deramond opened 1 year ago

julien-deramond commented 1 year ago

This PR adds a sample in the repository stored in the sample directory.

Closes #4

How it's been created

cd /tmp
mkdocs new .

Copied docs directory at the root level of this repository

Then run mkdocs serve and go to http://127.0.0.1:8000/Orange-OpenSource/ods-mkdocs-theme/

Screenshot 2023-10-05 at 09 04 36

No impact on package creation

Just to be sure, I've run python setup.py bdist_wheel sdist --formats gztar to generate the package and I can confirm that docs is not embedded into it.

Deploy to GH Pages manually

mkdocs gh-deploy

Deployed on https://orange-opensource.github.io/ods-mkdocs-theme/

Deploy to GH Pages for each commit on main branch

A new workflow has been created in .github/workflow/deploy.yml to run mkdocs gh-deploy for each commit on the main branch.

Deployed when the target branch was main-jd-add-sample: https://github.com/Orange-OpenSource/ods-mkdocs-theme/actions/runs/6416125734/job/17419252606.