Skip to content
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
Merged

Conversation

abrahamvarricatt
Copy link
Contributor

@abrahamvarricatt 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

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
Copy link
Member

@Kwpolska Kwpolska commented Sep 5, 2016

This should also be somewhere in the handbook.

@abrahamvarricatt
Copy link
Contributor Author

@abrahamvarricatt 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
Copy link
Member

@Kwpolska Kwpolska commented Sep 6, 2016

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

@@ -5,6 +5,7 @@ Bugfixes
--------

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

@Kwpolska Kwpolska Sep 6, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

removing CHANGES.txt entry
making a new section in manual.txt for embedding images
@abrahamvarricatt
Copy link
Contributor Author

@abrahamvarricatt 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
Copy link
Member

@Kwpolska Kwpolska Sep 6, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.. code:: rest

   .. image:: /images/example.png

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

@abrahamvarricatt
Copy link
Contributor Author

@abrahamvarricatt abrahamvarricatt commented Sep 6, 2016

Removed the attributes.

@Kwpolska Kwpolska merged commit 861c28a into getnikola:master Sep 8, 2016
2 checks passed
Kwpolska added a commit that referenced this issue Sep 8, 2016
Kwpolska added a commit that referenced this issue Sep 8, 2016
Signed-off-by: Chris Warrick <kwpolska@gmail.com>
@Kwpolska
Copy link
Member

@Kwpolska 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 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants