Verified Commit 687f471c authored by Yunus Sevinchan's avatar Yunus Sevinchan
Browse files

Attempt fixing myst.xref_missing warnings

parent cd0b8862

README.md

+1 −1
Original line number Diff line number Diff line
@@ -95,7 +95,7 @@ After cloning, there will be a new `utopia` directory (mirroring this repository 
Install the third-party dependencies using a package manager.



**Note:** If you have [Anaconda][Anaconda] installed, you already have a working Python installation on your system, and you can omit installing the `python` packages below.

However, notice that there might be issues during [the configuration step](#4-configure-and-build).

However, notice that there might be issues during [the configuration step](#3-configure-and-build).

Have a look at the [troubleshooting](#troubleshooting) section to see how to address them.



##### On Ubuntu (22.04)

doc/conf.py.in

+17 −0
Original line number Diff line number Diff line
@@ -260,6 +260,9 @@ epub_exclude_files = ["search.html"] 


# -- MyST ---------------------------------------------------------------------



# Generate heading anchors, which we need for cross-referencing

myst_heading_anchors = 5





# -- Todo extension -----------------------------------------------------------
@@ -490,10 +493,24 @@ def manipulate_source_read(app, docname: str, source: list): 
        ``source`` object (a list).

    """

    if docname == "README":

        print("\nAdjusting README content ...")



        # Drop everything before the installation instructions

        marker = "<!-- marker-installation-instructions -->"

        new_start = source[0].find(marker) + len(marker)

        source[0] = "# Installation" + source[0][new_start:]



        # Text Replacements

        # ... to take care of changes in how the link slugs are created by myst

        print("Carrying out text replacements ...")

        source[0] = source[0].replace(

            "#3-configure-and-build", "#configure-and-build"

        )

        source[0] = source[0].replace(

            "../src/utopia/models",

            "https://gitlab.com/utopia-project/utopia/-/tree/master/src/utopia/models",

        )



        return