Is it possible to link to files or images in the same project using Swift documentation markup kind of like Github does? I have snapshots of all my view classes and would really like to include those images in the documentation.
Something like this:
It works for symbol documentation and Playgrounds, but there's a difference.
For symbol documentation, only links to online images are supported.
Online and local images are supported in Playgrounds.
Local images have to be in the Playground's Resources folder.
/*:
*/
Reference: Apple documentation
Note: doesn't work with 7.3 beta.
Related
I use VSCode to develop my eleventy based static site. I also use it to edit posts in markdown. The preview of those posts is really helpful, however the image paths don't resolve properly, so they are not visible in the preview. This is because the root of the website is not the same as the root of the code.
The posts are in this folder:
/project-folder/src/posts
The images are in this folder
/project-folder/src/assets/images
But the root of the website is "src" so when adding the image into the markdown file, the path is like this:
Is there some way of informing the markdown previewer that paths should consider "src" as the root? If it's not possible, that's fine too. But it would be great to get the images to show in the markdown preview.
Thanks.
This is a known bug in the current version of VS Code:
https://github.com/microsoft/vscode/issues/165352
I'm trying to get Font Awesome to work in my nativescript-vue app, I'm following this tutorial:
https://nativescript-vue.org/blog/using-fonticons/
It says I have to download a file like fontawesome-webfont.ttf. and import it into my assets folder, can I have a direct link to download this file, I haven't found it in the official FA web.
You can get them from here, fontAwesome github
Look into the webfonts directory.
I'm already using a custom css to override some of the styles of the theme using
def setup(app):
app.add_css_file('custom.css')
This works fine. What other app. functions are available?
I can't find any documentation.
I'm looking for the function to override the favicon.
Thanks to #StevePiercy I found this documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon
conf.py
html_favicon = 'favicon.ico'
I put favicon.ico in my source folder, next to my .rst-files and it is working as expected:
https://global-coffee-data-standard.readthedocs.io/en/latest/index.html
In addition to Sphinx's native favicon support (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon), you can also use this Sphinx extension I created: https://pypi.org/project/sphinx-favicon/ With this extension, you can add multiple favicons, including apple-touch-icon and icons of different sizes. You can also use PNG or other supported file types.
I cannot view the images from boost.org documentation.
For example,
http://www.boost.org/doc/libs/1_58_0/libs/math/doc/html/math_toolkit/dist_ref/dists/hyperexponential_dist.html
Looking at the source code and clicking the image links, I get "Error 404: File not found".
Apparently my professor can view the images no problem, but my classmates and I cannot. Does anyone know why I can't view any of the images on the boost.org documentation website? Thanks.
The older 1.57.0 version is ok.
They changed their image format from PNG to SVG in v1.58.0, but these are not available on the site (the offline version contains the SVG files).
I'm trying to use Sphinx to build docuemntation to push to github pages. I'm using the default html builder to generate help documentation and pushing that into a gh-pages branch (see https://github.com/sbt/sbt-native-packager/tree/gh-pages).
It appears like the github pages integration doesn't like directories beginning with _, and makes the _static directory hidden. My site appears with no style (much like myself).
Is there any way to configure Sphinx to use static/ instead of _static/ in its generated pages? I tried html_static_path but no dice.
Thanks!
It is a known issue. See this Google Groups thread. The github-tools project has a workaround in sphinx.py.
See also https://stackoverflow.com/a/6398875/407651.