topic Re: Bug with YDK Documentation Generation in Tools

Bug with YDK Documentation Generation

brfoster — Tue, 20 Jun 2017 21:04:28 GMT

I found a bug with ydk-gen

When you generate documentation using the --generate-doc flag the html files reference a CSS file that does not exist. This line gets put in the HTML <head> section of every page...

If you look in the "_static" directory you will see this file does not exist but the "theme.css" does exist.

If you edit this to

Then the pages load correctly.

Re: Bug with YDK Documentation Generation

abhirame — Wed, 21 Jun 2017 15:29:55 GMT

Thanks! Do you have a link in the ydk-gen github repo to the file you re talking about?

Re: Bug with YDK Documentation Generation

brfoster — Wed, 21 Jun 2017 16:00:55 GMT

Hi,

I’m sorry, not sure what you are asking? I just did…

virtualenv -p python2.7 ydk-gen-venv-27

source ydk-gen-venv-27/bin/activate

cd PythonProjects/

git clone https://github.com/CiscoDevNet/ydk-gen.git

cd ydk-gen

pip install -r requirements.txt

python generate.py --python --bundle profiles/bundles/cisco-ios-xe_16_5_1.json -v --generate-doc

Then, I tried to access the “index.html” file that gets created under…

/home/gibson/PythonProjects/ydk-gen/gen-api/python/cisco_ios_xe-bundle/docs_expanded

And that is where I found the mal-formed HTML files with the incorrect CSS file name.

Thanks,

Brent

Re: Bug with YDK Documentation Generation

abhirame — Wed, 21 Jun 2017 17:44:41 GMT

Makes sense now. Thanks! This will be fixed soon on the ydk-gen repo

Re: Bug with YDK Documentation Generation

saalvare — Wed, 28 Jun 2017 15:38:09 GMT

Brent,

In case it helps, note that XE docs are currently hosted at http://ydk.cisco.com/py/docs/ydk.models.cisco_ios_xe.html

Also, Python package is now in PyPi at ydk-models-cisco-ios-xe · Warehouse (PyPI)