4. Sources

4.1. What common Markup languages should I use?

  • reStructuredText
  • Markdown
  • Jupyter notebooks
  • LaTEX

4.2. How to decide whether to use reStructuredText or Markdown?

4.2.1. Problem

4.2.2. Solution

Use both.

4.2.3. Discussion

4.3. How do I do common formatting (bold, italics) in rst and md?

4.3.1. Problem

4.3.2. Solution

4.3.3. Discussion

4.4. How do I add headings of different levels?

4.4.1. Problem

4.4.2. Solution

4.4.3. Discussion

4.5. How do I add lists?

4.5.1. Problem

4.5.2. Solution

4.5.3. Discussion

4.6. How do I highlight code, filenames?

4.6.1. Problem

4.6.2. Solution

4.6.3. Discussion

4.7. How do I add code blocks for different programming languages?

4.7.1. Problem

4.7.2. Solution

4.7.3. Discussion

4.8. What is a directive? How do I add warnings boxes, tip boxes?

4.8.1. Problem

4.8.2. Solution

4.8.3. Discussion

4.9. I would like to include text quoted from another source. How do I do that?

4.9.1. Problem

4.9.2. Solution

Use >

4.9.3. Discussion

4.10. How do I use Jupyter notebooks as sources?

4.10.1. Problem

4.10.2. Solution

4.10.3. Discussion

nbsphinx, nbconvert

4.11. I’ve started using Markdown but now I want to switch to reStructuredText?

4.11.1. Problem

4.11.2. Solution

4.11.3. Discussion

recommonmark

pandoc

4.12. What is pandoc? When should I use it?

4.12.1. Problem

4.12.2. Solution

4.12.3. Discussion

converting sources

4.13. How do I include images?

4.13.1. Problem

4.13.2. Solution

4.13.3. Discussion

4.14. How do I convert images to save space and load quickly?

4.14.1. Problem

4.14.2. Solution

4.14.3. Discussion

imagemagick

4.15. How do I modify sources for accessibility?

4.15.1. Problem

4.15.2. Solution

4.15.3. Discussion

4.16. How do I modify sources for internationalization?

4.16.1. Problem

4.16.2. Solution

4.16.3. Discussion