Document Your Scientific Project With Markdown, Sphinx, and Read the Docs | PyData Global 2021

Поділитися
Вставка
  • Опубліковано 13 гру 2024

КОМЕНТАРІ • 17

  • @ZioTeoPodcast
    @ZioTeoPodcast 10 місяців тому +1

    0:0:00 Introduction
    0:1:40 Overview of Sphinx
    0:4:43 Demo
    0:5:42 Overview of the repository
    0:7:05 Modifying the pyproject.toml file
    0:8:38 Install repository in editor mode
    0:10:20 Sphinx quickstart
    0:18:59 MyST introduction
    0:20:00 Install MyST
    0:20:20 Convert rST to MyST
    0:25:43 Install sphinx-autobuild
    0:27:38 Including README in the documentation
    0:30:26 Customizing Sphinx
    0:42:12 Embedding notebooks
    0:49:50 Documenting code
    1:04:00 Deployment

  • @LukeWilliams-x4s
    @LukeWilliams-x4s 10 місяців тому +2

    I don't regularly comment on UA-cam videos, but I was playing with sphinx for a POC for my project and came across your video. You talked about EXACTLY what I needed to know. I already had markdown configured with the extension but didn't yet understand how to convert the syntax from .rst to .md, and your markdown file gave me a tip on how to not just re-write it all in markdown but also how to reference the existing markdown files I had within the project I was attaching the POC too. Superb video.

  • @isaacdiaby
    @isaacdiaby 3 місяці тому

    Your a star! 2 years later and the quality here still holds

  • @binyang7362
    @binyang7362 2 роки тому +1

    1:50 1. Creating your Sphinx project
    2:35 Sphinx source files and output
    4:00 Objective of tutorial and sample code
    5:20 Environment set up
    9:50 quick start (demo)

  • @sedaradoykova9636
    @sedaradoykova9636 Рік тому

    an excellent tutorial! got my project docs up and running in half a day. thank you very much!

  • @josephpaik6756
    @josephpaik6756 2 роки тому

    I was searching for a way to manage technical documents, and this is the course I really want. thank you, Juan

  • @datadiggers_ru
    @datadiggers_ru 2 роки тому +1

    This is exactly the information I was looking for. Thank you

  • @mattbillman4688
    @mattbillman4688 2 роки тому +1

    This was so incredibly helpful - cleared up a lot of confusion. Thank you!

  • @shivangvijay9385
    @shivangvijay9385 Рік тому +2

    I am not able to find github link for this project. Can anybody help.

  • @siva82kb
    @siva82kb 2 роки тому

    Thank you, Juan. This was highly valuable.

  • @tombischopink3343
    @tombischopink3343 Рік тому

    really nice. Just created a good and clear docu. My co-workers will love me :)

  • @samlopezruiz
    @samlopezruiz 2 роки тому

    Amazing tutorial!
    Super helpful

  • @marcosantonioeuzebiodeoliv8515
    @marcosantonioeuzebiodeoliv8515 2 роки тому

    My mind is blowing!!!🤯🤯🤯🤯🤯🤯🤯

  • @bolundai
    @bolundai 2 роки тому

    49:50 Automatic Code Generation

  • @k-daym_val5913
    @k-daym_val5913 2 роки тому

    how can i embed videos in documentations?

  • @rakurame6990
    @rakurame6990 2 роки тому

    Getting stuck in the
    Serving HTTP on :: port 8000 ([::]:8000/) ...
    Any suggestions are helpful