diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d8dfb64..b3817ab9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ To do so, follow these steps: 2. Build the documentation: ``` - nox -s docs_build + nox -s docs ``` This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`. @@ -41,5 +41,5 @@ This should create a local environment in a `.nox` folder, build the documentati To build live documentation that updates when you update local files, run the following command: ``` -nox -s docs_live +nox -s docs-live ``` diff --git a/_static/pyopensci-python-package-guide.png b/_static/pyopensci-python-package-guide.png new file mode 100644 index 00000000..cad4d0ff Binary files /dev/null and b/_static/pyopensci-python-package-guide.png differ diff --git a/conf.py b/conf.py index 56974db7..74f37267 100644 --- a/conf.py +++ b/conf.py @@ -134,5 +134,5 @@ # Social cards -ogp_site_url = "http://www.pyopensci.org/python-package-guide" -ogp_image = "https://www.pyopensci.org/python-package-guide/_static/logo-light-mode.png" +ogp_site_url = "https://www.pyopensci.org/python-package-guide/" +ogp_image = "_static/pyopensci-python-package-guide.png" diff --git a/tutorials/1-installable-code.md b/tutorials/1-installable-code.md index 559edc76..cacb9b8b 100644 --- a/tutorials/1-installable-code.md +++ b/tutorials/1-installable-code.md @@ -1,3 +1,8 @@ +--- +:og:description: Learn how to make your Python code installable so you can use it across projects. +:og:title: Make your Python code installable so it can be used across projects +--- + # Make your Python code installable :::{admonition} What we previously covered