mhausenblas / mkdocs-deploy-gh-pages

GitHub Action to deploy an MkDocs site to GitHub Pages
Apache License 2.0
249 stars 90 forks source link

How to use custom modules? #97

Open Hkr32 opened 3 years ago

Hkr32 commented 3 years ago

I'm trying to set up the deployment of this repository, but there is a separate topic and additional modules and its own command to launch. How can this be combined?

https://github.com/hestiacp-ru/hestiacp-docs

mhausenblas commented 3 years ago

Not sure I follow. Did you try out https://github.com/mhausenblas/mkdocs-deploy-gh-pages#installing-extra-packages and it didn't work or …? :)

Hkr32 commented 3 years ago

I pointed it this way, but it didn't work: EXTRA_PACKAGES: sphinx sphinx-tabs sphinx_rtd_theme sphinxcontrib.yt

https://github.com/hestiacp-ru/hestiacp-docs/runs/2464965447?check_suite_focus=true

There is just your own config, not format .yml https://github.com/hestiacp-ru/hestiacp-docs/blob/master/conf3.py

rekire commented 3 years ago

I ran into the same Issue. I got this output:

INFO: setup with GITHUB_TOKEN
ERROR    -  Config value: 'plugins'. Error: The "codeinclude" plugin is not installed
Aborted with 1 Configuration Errors!

So I added this line:

EXTRA_PACKAGES: mkdocs-codeinclude-plugin mkdocs-material

However I get now this error:

fetch https://dl-cdn.alpinelinux.org/alpine/v3.13/community/x86_64/APKINDEX.tar.gz
ERROR: unable to select packages:
  mkdocs-codeinclude-plugin (no such package):
    required by: world[mkdocs-codeinclude-plugin]

@mhausenblas do you know how to fix it?

Just executing pip install mkdocs-codeinclude-plugin mkdocs-material does not work for me.

rekire commented 3 years ago

I found it out: You need to use the undocument environment variable REQUIREMENTS to link to a requirements.txt file. This is not mentioned in the README file.

mhausenblas commented 3 years ago

I thought we did already, sorry. Want to PR the docs to include it @rekire ?

rekire commented 3 years ago

I was already creating a PR :-D