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

Clarify image usage #2494

Merged
merged 3 commits into from Sep 8, 2016

Conversation

Projects
None yet
2 participants
@abrahamvarricatt
Copy link
Contributor

abrahamvarricatt commented Sep 5, 2016

The documentation in the auto-generated conf.py is a little vague
with how images can be used. The patch clarifies that ambiguity.

refer discussion here:
https://groups.google.com/d/topic/nikola-discuss/WDhmd6bEPm8/discussion

Clarify image usage
The documentation in the auto-generated conf.py is a little vague
with how images can be used. The patch clarifies that ambiguity.

refer discussion here:
https://groups.google.com/d/topic/nikola-discuss/WDhmd6bEPm8/discussion
@Kwpolska

This comment has been minimized.

Copy link
Member

Kwpolska commented Sep 5, 2016

This should also be somewhere in the handbook.

@abrahamvarricatt

This comment has been minimized.

Copy link
Contributor

abrahamvarricatt commented Sep 6, 2016

@Kwpolska do you mean here - https://github.com/getnikola/nikola-site/blob/master/stories/manual.txt ? If so, I'll send a pull request to that repository too.

@Kwpolska

This comment has been minimized.

Copy link
Member

Kwpolska commented Sep 6, 2016

docs/manual.txt in this repository (make a second commit to your clarify-image-usage branch)

CHANGES.txt Outdated
@@ -5,6 +5,7 @@ Bugfixes
--------

* Don’t crash if a post list has no posts (Issue #2489)
* Clarify conf.py documentation on using images

This comment has been minimized.

@Kwpolska

Kwpolska Sep 6, 2016

Member

(We don’t really need that level of detail in changelogs.)

# :align: center

# Images will be scaled down according to IMAGE_THUMBNAIL_SIZE and MAX_IMAGE_SIZE
# options, but will have to be referenced manually to be visible on the site

This comment has been minimized.

@Kwpolska

Kwpolska Sep 6, 2016

Member

We have the .. thumbnail:: reST directive that uses thumbnail files.

# For example, if IMAGE_FOLDERS = {'images': 'images'}, write
#
# ..image:: /images/example.png
# :height: 300px

This comment has been minimized.

@Kwpolska

Kwpolska Sep 6, 2016

Member

Minimum example, please. Just the .. image:: /images/example.png line is enough.

editing example to bare minimum code
removing CHANGES.txt entry
making a new section in manual.txt for embedding images
@abrahamvarricatt

This comment has been minimized.

Copy link
Contributor

abrahamvarricatt commented Sep 6, 2016

Not sure how to include information about thumbnail directive in conf.py without being too verbose. Have made the other changes - also updated the manual entry with an ReST example. Included the thumbnail directive there.

Does it look good now?

Assuming that you have your pictures stored in a folder called images (as configured above),
you can embed the same in your posts with the following ReST directive,

.. code:: python

This comment has been minimized.

@Kwpolska

Kwpolska Sep 6, 2016

Member
.. code:: rest

   .. image:: /images/example.png

That will be enough. Without height, width, alt, align.

@abrahamvarricatt

This comment has been minimized.

Copy link
Contributor

abrahamvarricatt commented Sep 6, 2016

Removed the attributes.

@Kwpolska Kwpolska merged commit 861c28a into getnikola:master Sep 8, 2016

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

Kwpolska added a commit that referenced this pull request Sep 8, 2016

Kwpolska added a commit that referenced this pull request Sep 8, 2016

Minor copyediting for #2494
Signed-off-by: Chris Warrick <kwpolska@gmail.com>
@Kwpolska

This comment has been minimized.

Copy link
Member

Kwpolska commented Sep 8, 2016

Merged (and expanded on a bit in a6a3471), thanks. This will go live on our website whenever we release v7.8.0.

@abrahamvarricatt abrahamvarricatt deleted the abrahamvarricatt:clarify-image-usage branch Sep 8, 2016

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