Documentation issues

[simone-hochgreb]

This is a good contribution.

I could get the straightforward examples running, but I am having serious trouble adapting my original .rst pages with this interface, because it is difficult to find documentation on the classes and attributes.

For example, looking at the featurette under the carousel example:

` .. container:: col-md-5

 .. container:: featurette-image img-fluid mx-auto
    :tagname: img
    :attributes: data-src="holder.js/500x500/auto"
         alt="Generic placeholder image"
    :endless:

`

All I am I trying to do is to change the number of columns the figure/test occupy, and change the figure. But I don't seem to be able to get the image I have (pointing it to the file in a subfolder) to be read.

Is it possible to get a list of the features that each class has and the syntax for its usage? I have spent many hours on this now, and about to give up.

I have all my pages using Ryan Roemer's rest to bootstrap, but it has some limitations, so I was keen to use the present one, but I cannot find sufficient documentation to port them.

I would appreciate any pointers.

[rougier]

You mean the given examples are not self-explanatory?

[simone-hochgreb]

The tool is very nice, and the examples are clear. Where things break down are for example, in the attached page, where I am trying to replace this section:

 .. container:: featurette-image img-fluid mx-auto
    :tagname: img
    :attributes: data-src="holder.js/500x500/auto"
         alt="Generic placeholder image"
    :endless:

How do I find out what the particular features of the container (featurette, mx-auto, data-src, endless) should contain? For example, I tried replacing the data-src with an image, but that did not work, I am not sure where to find information about this particular class.

The examples do not help in that matter, so there is much trial an error.

Hopefully I am just looking in the wrong place.

Best,

Simone

On 28 Mar 2018, at 13:21, Nicolas P. Rougier notifications@github.com wrote:

You mean the given examples are not self-explanatory?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/rougier/bootstrap-rst/issues/41#issuecomment-376866877, or mute the thread https://github.com/notifications/unsubscribe-auth/ADygnixYitZPk588HGbmkwLNfXXKcF8Kks5ti4BWgaJpZM4S8oRa.

[simone-hochgreb]

The tool is very nice, and the examples are clear. Where things break down are for example, in the attached page, where I am trying to replace this section:

 .. container:: featurette-image img-fluid mx-auto
    :tagname: img
    :attributes: data-src="holder.js/500x500/auto"
         alt="Generic placeholder image"
    :endless:

How do I find out what the particular features of the container (featurette, mx-auto, data-src, endless) should contain? For example, I tried replacing the data-src with an image, but that did not work, I am not sure where to find information about this particular class.

The examples do not help in that matter, so there is much trial an error.

Hopefully I am just looking in the wrong place.

On 28 Mar 2018, at 13:21, Nicolas P. Rougier <notifications@github.com mailto:notifications@github.com> wrote:

You mean the given examples are not self-explanatory?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/rougier/bootstrap-rst/issues/41#issuecomment-376866877, or mute the thread https://github.com/notifications/unsubscribe-auth/ADygnixYitZPk588HGbmkwLNfXXKcF8Kks5ti4BWgaJpZM4S8oRa.

[rougier]

I don't see the attached page actually. Maybe this is because you answered by mail and the attachment did not made it throught the GitHub interface.

[simone-hochgreb]

Apologies, here it is (rst as txt for GitHub compliance).

research.txt

[akuroiwa]

.. container:: featurette-image img-fluid mx-auto will be replaced with:

<img class="featurette-image img-fluid mx-auto">

Since data-src calls bootstrap/js/holder.min.js to display gray screen, you might use src attribute. :endless: omits the end tag.

[simone-hochgreb]

That is nice, but where do I find a general list of all the potential attributes of each class available to the program?

[akuroiwa]

I don't know the reference page, but some attributes call bootstrap.min.css.

[simone-hochgreb]

I see. I was trying to separate what comes from the present tool, vs. what comes from bootstrap. I will look it up.