dffml icon indicating copy to clipboard operation
dffml copied to clipboard

Published 20 hours ago • verified publisher icon intel

docs:

Open Rennylex opened this issue 2 years ago • 5 comments

Hi, it's Lex here. Just a tiny issue...looks like the documentation for the master branch has become 404 Meanwhile, I can browse https://intel.github.io/dffml/master/api/index.html normally, though I can not edit it successfully(it's another 404). Will we update on that?

Rennylex avatar Mar 02 '22 13:03 Rennylex

Can you post a screenshot with the URL in it so we can better understand what's not rendering please? Thanks for reporting! I wasn't able to see the same issue.

johnandersen777 avatar Mar 03 '22 15:03 johnandersen777

image image image

Looks like I was using an old url or something...now I can browse the master branch normally (I am so sorry for not checking carefully). However, 404 still occur when I try to edit these pages.

Rennylex avatar Mar 04 '22 02:03 Rennylex

I believe this is an inconsistency rather than an issue, as you're trying to browse the API docs which are auto-generated by Sphinx and we don't have .rst files for them.

programmer290399 avatar Mar 04 '22 03:03 programmer290399

OK got it. If I want to edit these pages, what should I do?

Rennylex avatar Mar 04 '22 05:03 Rennylex

They are generated using the code, so the documentation is built using the docstrings written in the code. To edit these docs you need to edit the docstrings and the changes will reflect when you build the code. For more information refer this

programmer290399 avatar Mar 04 '22 08:03 programmer290399