search

OpenDataServices / sphinxcontrib-opendataservices

Sphinx directives maintained by Open Data Services
MIT License
0 stars 0 forks source link

Markdown in admonitions #3

Closed Bjwebb closed 5 years ago

Bjwebb commented 6 years ago

Instead of creating a new "example in markdown dirctive", I've created a markdown directive that can be embedded in a number of places, including admonitions. See https://sphinxcontrib-opendataservices.readthedocs.io/en/latest/#directive-markdown for an example. @timgdavies Does this do what you need?

timgdavies commented 6 years ago

This is great Ben :) Yes - this looks just the job.

Bjwebb commented 6 years ago

Docs are now at https://sphinxcontrib-opendataservices.readthedocs.io/en/latest/misc/#directive-markdown

duncandewhurst commented 5 years ago

I'm trying to use this directive in OC for Infrastructure on this branch, but the markdown isn't rendering.

In assess-against-ids.md I have the following:

```eval_rst
.. admonition:: Tip
    :class: Tip

    .. markdown::

    You can use the [OCDS Data Review Tool](http://standard.open-contracting.org/review/) to check that whether your data is published in OCDS format.

But the markdown hyperlink doesn't render:

image

The latest commit in this repo is specified in requirements.txt and conf.py has sphinxcontrib.opendataservices in the extensions array per the installation instructions.

@robredpath could someone take a quick look at where I'm going wrong?

duncandewhurst commented 5 years ago

nevermind, I just needed to indent the text