Hi,

Great course!

I got stuck watching this video here. That's because I believe you forgot to mention how to build the HTML using make html. In other words, the folder _build is still empty after watching Make a sphinx site. Perhaps you forgot to record that part?

Either way, I found your post here

I am also creating my guide using conda to help me through the training. Please check here

Thanks again!!

Cheers
Fernando

The first time the author uses the directive {download}logofile.png the logofile is moved to _build/_download/hashthing/logofile.png.
The Author mentions exactly that.

However the file is MOVED from the root dir and is not available for other directives anymore. e.g. {image} or link.

This is not a biggie, but still.

Thank you for the course.

Nice course, thanks for making it free!

I might’ve missed it but I think it would be good to get Github or Vercel or someone to host a final version so everyone can see what the end product looks like.

Hi,

I'm having an issue just getting the sphinx-quickstart generated site up and running. :(

I'm on macOS (Catalina 10.15.7), using pipenv for virtualization and using Python 3.10.1.

Apart from that, nothing strikingly different from the course but I'm just getting a 404 message when I run the run_livereload.py script and go to the local host address that's given.

Please view a copy of the code here: Schlockchain

Any ideas to help resolve this would be very much appreciated! :)

Thanks
Michael

In the tutorial, it states that links will be created to navigate around when autodoc is used to document code. I have set up conf.py and api.md for that but the only links that I'm getting are the ones in the navigation pane on the generated output.

Paul's web page on this course at says:

It's visually attractive. More than that, though...it's semantically rich: links to navigate around, styling for the structure, and more.

Yes, it's semantically rich, etc., but I see no links to navigate around in the code.

I have set up conf.py with the prerequisite extensions:

extensions = [
    "myst_parser",
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx_autodoc_typehints",
    "sphinx.ext.intersphinx",
]

And created api.md:

    # About `MyDemo`

    Let's take a look at this Python class.

    ```{eval-rst}
     .. autoclass:: my_demo.MyDemo
       :members:
     ```

     # About `MyClass`

     ```{eval-rst}
     .. autoclass:: my_demo.MyClass
        :members:
     ```

The Python file my_demo.py looks like this:

class MyDemo:
    """ A *great* demo """
    def __init__(self, name):
        self.name = name

    def hello(self):
        """ Be friendly """
        return f"Hello {self.name}"


class MyClass:
    """ A *great* demo """

    def __init__(self, name):
        self.name = name

    def hello(self, greeting: str) -> str:
        """ The canonical hello world example.

        A *longer* description with some **RST**.

        Args:
            name: The person to say hello to.
        Returns:
            str: The greeting
         """
        return f"{greeting} {self.name}"

The resultant HTML page looks like this but nothing in the code has links:

Is that correct? Or am I missing something?

Thanks
Michael