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 image links broken in locally generated YARD docs. #822

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

Documentation image links broken in locally generated YARD docs. #822

DanRathbun opened this issue Aug 11, 2022 · 3 comments

Comments

@DanRathbun
Copy link

DanRathbun commented Aug 11, 2022

SketchUp API Documentation Issue

The "rdoc-image:" tags do not work for locally generated YARD doc pages.

(I use the Redcarpet markdown parser gem, btw.)

This is occurring with:


For example, I have to edit them to use markdown image links, ie:

  # rdoc-image:images/geom-tesselation-polygon-with-holes.png

... must be changed to:

  # ![](images/geom-tesselation-polygon-with-holes.png)

Note, the above link is from the "Geom.rb" file (later "Geom.html") which is in the same folder as the "images" folder.

The other class files need "../" prepended to their image paths because they are in subfolders of the "doc" directory.
Ie, for Sketchup::View#draw_text's image:

  # **Example of different vertical alignment and text bounds:**
  #
  # ![Vertical Text Alignments](../images/view-draw-text-with-bounds.png)

~

@thomthom
Copy link
Member

The Ruby API docs are not using Markdown, it's using Rdoc. I wish it was Markdown, but we've not had the time to reformat everything to Markdown. (The additional pages are Markdown, but not the doc comments)

@DanRathbun
Copy link
Author

Could this be a template issue ? I mean is it possible to convert these "rdoc-image:" tags to inline <img> HTML elements ?

@DanRathbun
Copy link
Author

Let's label this as question, answered and close it. Any further discussion can happen in the API Stubs repo issue thread:
SketchUp/ruby-api-stubs#78

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

No branches or pull requests

2 participants