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

Missing API Documentation Images #78

Open
DanRathbun opened this issue Aug 11, 2022 · 3 comments
Open

Missing API Documentation Images #78

DanRathbun opened this issue Aug 11, 2022 · 3 comments
Labels

Comments

@DanRathbun
Copy link
Contributor

DanRathbun commented Aug 11, 2022

Missing API Documentation Images

The following images are missing from the "images" subfolder of the stubs repo.

  • "entities-builder-grid-example.png"
  • "face-uv-tile-at.png"

(I had to manually copy them off the web and save it into my local stubs repository.)

Also, the embedded image links in the stubs suffer from not being a markdown image link per:

@DanRathbun DanRathbun changed the title Missing EntitiesBuilder triangulated grid example image **Missing API Documentation Images** Aug 13, 2022
@DanRathbun DanRathbun changed the title **Missing API Documentation Images** Missing API Documentation Images Aug 13, 2022
@thomthom thomthom added the bug label Aug 17, 2022
@thomthom
Copy link
Member

As mentioned in #822, the doc comments are using RDoc, not Markdown. A remains of the old documentation that we've never had the time to reformat to Markdown. (Tried, but quickly snowballed - and not something you can partially migrate to.)

@DanRathbun
Copy link
Contributor Author

Does not mean that you cannot include the image files in the repos "image" directory.

Meaning that this is a separate but related issue.

@DanRathbun
Copy link
Contributor Author

As mentioned in #822, the doc comments are using RDoc, not Markdown.

As I mused in the API DOC Issue 822, Since this has to do with the Stubs output, not API Docs output, and since they have separate YARD templates, ... could this be corrected in the template for the stubs ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants