Everand Logo

Welcome to Everand!

  • Discover millions of ebooks, audiobooks, and so much more with a free trial

    Only $11.99/month after trial. Cancel anytime.

    reStructuredText for Sphinx
    reStructuredText for Sphinx
    reStructuredText for Sphinx
    Ebook60 pages10 minutes

    reStructuredText for Sphinx

    By Vimalkumar Velayudhan

    ()

    Read preview

    About this ebook

    This book will help you learn the basic reStructuredText (reST) syntax used in writing documentation using Sphinx.

     

    What you will learn

    • Create a new Sphinx project
    • Learn to write sections, links, images, footnotes, abbreviations, code samples, and more using the reST syntax
    • Live preview your writing (HTML)

    Which will help you

    • Write documentation for your projects
    • Contribute to projects using Sphinx
    • Publish a book or a manual
    • Create a static website using Pelican
    LanguageEnglish
    PublisherVimalkumar Velayudhan
    Release dateJul 26, 2023
    ISBN9798223236023
    reStructuredText for Sphinx

    Related to reStructuredText for Sphinx

    Related ebooks

    Computers For You

    View More
    View More

    Related podcast episodes

    Related articles

    • Article

      Mark Your Media Files

      Nov 17, 2020

      When using an embedded system as a media centre, you need to know about NFO files. The files keep track of the meta data for your titles. They’re XML files that contain information on the song, movie or other media that you’re accessing. For example,

      6 min read

    • Article

      Build Your Own Distro With NixOS

      Apr 4, 2023

      Credit: https://nixos.org Matt Holder has been a fan of the open source methodology for over two decades and uses Linux and other tools where possible. In his spare time, he enjoys listening to music and reading. We’re continuing our look at next-gen

      10 min read

    • Article

      Direct From the Source

      Oct 22, 2019

      Direct From the Source
      8 min read

    • Article

      Get More From Wine And Windows

      May 3, 2022

      Wine enables the Linux user to run software that was designed to run under Windows directly on the Linux desktop. Wine stands for Wine Is Not An Emulator, and that gives some clue as to how it works. Rather than emulating a PC, as is the case with a

      9 min read

    • Article

      Get More From Wine And Windows

      May 3, 2022

      Wine enables the Linux user to run software that was designed to run under Windows directly on the Linux desktop. Wine stands for Wine Is Not An Emulator, and that gives some clue as to how it works. Rather than emulating a PC, as is the case with a

      9 min read

    • Article

      Write A Linux Shell From Scratch

      Dec 12, 2023

      Part One! Don’t miss next issue, subscribe on page 16! Ferenc Deak wanted to use Malbolge to create a Linux shell, but after several days in hell, he quickly came to his senses and continued the project in C++. Not that there is a huge difference… E

      9 min read

    • Article

      Linux In Windows

      Oct 18, 2022

      Linux In Windows
      9 min read

    • Article

      Get Packing!

      May 3, 2022

      Get Packing!
      8 min read

    • Article

      Get Packing!

      May 3, 2022

      Get Packing!
      8 min read

    • Article

      Hot Picks

      Jun 1, 2021

      Hot Picks
      12 min read

    • Article

      FLASK Web Frameworks

      Jun 4, 2019

      The main focus of Python has always been to get you cracking on with your coding – the language was never made for web programming. However, this has just made it more interesting to extend the language for the web, or to create an interface to web-b

      9 min read

    • Article

      Sounds Like Trouble

      Sep 19, 2023

      $ sudo apt-get -qq install -y sox libsox-dev libpulse-dev make gcc g++ wget curl libc6:armhf $ sudo dpkg --add-architecture armhf $ sudo apt-get -qq install -y pulseaudio The product ships as a precompiled binary, which is only provided as a 32-bi

      4 min read

    • Article

      Create Your Own Chromecast Device

      Mar 8, 2022

      Mats Tage Axelsson would love to broadcast about all things Linux 24/7. We’re sure that it would be must-watch TV. We all spend an inordinate amount of time consuming video and music. Many of these services are streamed via browsers, but that’s not a

      9 min read

    • Article

      Create Your Own Chromecast Device

      Mar 8, 2022

      Mats Tage Axelsson would love to broadcast about all things Linux 24/7. We’re sure that it would be must-watch TV. We all spend an inordinate amount of time consuming video and music. Many of these services are streamed via browsers, but that’s not a

      9 min read

    • Article

      React Native For Desktop

      Nov 19, 2019

      As an alternative to this, you could use the regular React Native and add a new target. This is what the React Native Desktop team has done. To use it, you need to download it from GitHub or run a modification script that adds the ‘desktop’ option: h

      1 min read

    • Article

      Getting Started With The Powerful EBPF

      Sep 20, 2022

      Credit: https://ebpf.io Don’t miss next issue! Subscribe on page 16 Mihalis Tsoukalos is a systems engineer and a technical writer. You can reach him at www. mtsoukalos.eu and @mactsouk. Get the code for this tutorial from the Linux Format archive:

      10 min read

    • Article

      Docker Tips & Tricks

      Sep 13, 2022

      Docker Tips & Tricks
      8 min read

    • Article

      Build And Compile For Embedded Systems

      Nov 17, 2020

      Mats Tage Axelsson and a whole pile of compiling time. Mats Tage Axelsson has spent decades figuring out reasons to use Linux computers while sacrificing real social interactions. Embedded systems are small, specialised units with a key attribute

      4 min read

    • Article

      Nextcloud

      Jan 5, 2021

      Nextcloud
      4 min read

    • Article

      Distro Watch

      Aug 25, 2020

      Lovers of reptile-based distros will love the latest spin of GeckoLinux, a rolling-release distro spun off openSUSE, Tumbleweed and Packman repositories. It’s focused on giving a slick user experience out of the box, and includes restricted media cod

      1 min read

    • Article

      HotPicks

      Nov 15, 2022

      HotPicks
      12 min read

    • Article

      Art Beyond The Canvas

      May 2, 2023

      Art Beyond The Canvas
      9 min read

    • Article

      SEMAPHORE 2.0 Create Pipelines And Automate Development

      Jun 4, 2019

      Semaphore 2.0 is a Continuous Integration (CI) and Continuous Delivery (CD) tool that will make your life easier should you choose to spend some time to learn it. We’ll discover how to install the command line tool that enables you to work with Semap

      7 min read

    • Article

      Running With Nixos

      Jan 12, 2021

      Running With Nixos
      1 min read

    • Article

      Becoming a Docker

      Aug 24, 2020

      Becoming a Docker
      4 min read

    • Article

      Visual Studio Code 1.74

      Mar 7, 2023

      Visual Studio Code 1.74
      2 min read

    • Article

      Hot Picks

      Mar 9, 2021

      Hot Picks
      13 min read

    Related categories

    Reviews for reStructuredText for Sphinx

    0 ratings

    0 ratings0 reviews

    What did you think?

    Tap to rate

    Review must be at least 10 words

      Book preview

      reStructuredText for Sphinx - Vimalkumar Velayudhan

      Enjoying the preview?
      Page 1 of 1