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

Documentation-builder: rework to be more agnostic #330

Merged
merged 1 commit into from Mar 4, 2020

Conversation

wdpypere
Copy link
Contributor

  • allows exports of variable annotations
  • a lot of the assumptions originally made for configuration-modules-core are taken out and made configurable

@jrha
Copy link
Member

jrha commented Dec 20, 2019

I've read through the code (as much as I could) and tested this on a development system, a few observations:

  1. Not all of the run-time dependencies are obviously documented, on CentOS 7 I had to:

    cpan install Pod::Markdown
    cpan install Pod::POM::View::Restructured
    pip install -U Sphinx
    yum install htop
    yum install mkdocs
    yum install python2-devel
    yum install python2-mock
    yum install python2-pip
    yum install rubygem-bundler
  2. The README doesn't seem to match the options available with --help anymore?

  3. The build script is hard-coded to call firefox which is a fun surprise if it is not available, I symlinked this to echo on my headless build systems.

  4. I couldn't get it to work with Python 3, I didn't spend too long on it, but it looks like it is related to something in the vsc libraries rather than this script.

@jrha
Copy link
Member

jrha commented Dec 20, 2019

But on the plus side, it generated beautiful documentation!

@jrha
Copy link
Member

jrha commented Jan 21, 2020

I will use this to generate the 19.12 docs and may well merge after that.

@wdpypere
Copy link
Contributor Author

@jrha thanks for picking this up!

Copy link
Member

@jrha jrha left a comment

Choose a reason for hiding this comment

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

Works as intended.

@jrha jrha merged commit 29bdd45 into quattor:master Mar 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants