I'm trying to get a download link to work in Read the Docs using reStructuredText (reST) and Sphinx. In the reST documentation for the download role the example to provide a download link is given as
.. only:: builder_html
See :download:`this example script <../example.py>`.
When making the html source locally the links appear, but when using a GitHub linked project on Read the Docs, they do not.
As explained in this GitHub Issue Read the Docs uses its own builder called readthedocs. Thus, to include the download links you must also include this builder. For example
.. only:: builder_html or readthedocs
See :download:`this example script <../example.py>`.
Related
I'm using Spring Rest Docs to generate the API documentation for my APIs.
Now I want to add an image to this documentation. I know how to link the image in the asciidoctor file, and in IntelliJ Idea the preview shows the image, but when I generate the API documentation using Rest Docs and Gradle, the image is not shown.
What do I need to do in order to get the image in the generated API documentation?
It was actually rather simple to get this done. Thanks to the remark by Andy Wilkinson I dug back into the documentation.
I used a folder called 'resources' relative to the .adoc file instead of naming that folder 'images', after renaming it to 'images' my images show up.
I'm using Sphinx to document a python package that wraps a proprietary API that wasn't documented using Sphinx as far as I can tell. The API documentation provides useful information, but the URL's are not in a format that sphinx can automatically generate links for. Is it possible to mark a string semantically as a class, while specifying the link target by hand?
I tried:
:class:`Class <https://api.documentation/some/path/to_class_constructor.htm>`_
but this raises a WARNING: Mismatch: both interpreted text role prefix and reference suffix.. Then I also tried
:class:`Class <https://api.documentation/some/path/to_class_constructor.htm>`
which doesn't raise a warning, but doesn't generate a hyperlink either.
As per Steve Piercy's comment below, the sphinx.ext.extlinks extension keeps the documentation a little cleaner, but it looses its semantic meaning, which I would prefer to keep.
Is it possible to somehow show the text references a class, and at the same time links to the external API documentation?
I've been digging all around the web and can't figure out how to generate a LRD and ludocid. I'm trying to create a simple review link generator but can't seem to get anything of it. I know the procedure of viewing page source etc but I'm trying to make it so it automatically gets it from the input..
This blog post explains both: https://www.theedesign.com/blog/2016/how-to-create-a-google-review-url-with-the-new-g-layout
we want an auto publisher , whenever an joomla article is published, automatically publishes the article data such as title, image, description etc, on the Instagram. If this possible or not?
Yes this is possible with a content - plugin. You can use the onContentAfterSave event to do that.
Within this very callback you get the Article as parameter, so you can access all details of it, to create the webservice call.
There are some more events which plugins can listen to. Joomla Plugins are pretty simple to develop, basically they consist of an describing xml and a php file and you can find documentation here. To get started you should have a look at an existing content plugin (/plugins/content/*).
The actual call to instagram can be done using curl.
Looking out for an Instagram api, I found that: github.com/cosenary/Instagram-PHP-API and instagram.com/developer. I hope that can help you with the webservice call.
There is an extension in JED that will lessen your burden of coding. You can have a look at it here http://extensions.joomla.org/extensions/extension/social-web/social-display/jfbconnect . Remember thats a Paid extension.
I'm trying to use a Maven build to deploy to Confluence site using XML-RPC.
I'm having trouble finding the right protocol to use in distribution management. It is password protected.
Use one or both of the following:
Proxy Configuration
Maven Server Authentication
I don't think it's a good idea. Maven Site does not fit so well for Confluence: they have a specific layout... you should customize a lot of things in order to create a site that could be uploaded to Confluence, and the deployment is only the tip of an iceberg.
Instead, I suggest you to think to a different content, written in Markdown (or asciidoc, ...). It's very easy to convert those type of content in HTML compatible with Confluence.
By the way, if you need to upload a maven site style I suggest you to take a look at maven-confluence-plugin: in the wiki pages you can find the configuration to apply to do what you need.
I'm working on a similar plugin too. It's called confluence-maven-plugin. However the phylosophy of my plugin is not to be able to upload site, but to upload simple Markdown documentation to a confluence, guided mainly by a README.md as you probably do when you work with Github/BitBucket/etc...