cancel
Showing results for 
Search instead for 
Did you mean: 
cancel
Announcements
479
Views
1
Helpful
4
Replies
brfoster
Cisco Employee

Bug with YDK Documentation Generation

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...

<link rel="stylesheet" href="_static/css/width.css" type="text/css">

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

<link rel="stylesheet" href="_static/css/theme.css" type="text/css">


Then the pages load correctly.

1 ACCEPTED SOLUTION

Accepted Solutions

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

View solution in original post

4 REPLIES 4
abhirame
Cisco Employee

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

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

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

View solution in original post

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)

Create
Recognize Your Peers
Content for Community-Ad