Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various RST links #2676

Merged
merged 2 commits into from
Dec 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion datasets/doc/source/how-to-use-with-tensorflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ In case of CIFAR10, you should see the following output.
'label': ClassLabel(names=['airplane', 'automobile', 'bird', 'cat', 'deer', 'dog',
'frog', 'horse', 'ship', 'truck'], id=None)}
We will use the keys in the partition features in order to construct a `tf.data.Dataset <https://www.tensorflow.org/api_docs/python/tf/data/Dataset>_`. Let's move to the transformations.
We will use the keys in the partition features in order to construct a `tf.data.Dataset <https://www.tensorflow.org/api_docs/python/tf/data/Dataset>`_. Let's move to the transformations.

NumPy
-----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Source: `Official VSCode documentation <https://code.visualstudio.com/docs/remot
Getting started
---------------

Configuring and setting up the :code:`Dockerfile` as well the configuration for the devcontainer can be a bit more involved. The good thing is you don't have to do it. Usually it should be enough to install [Docker](https://docs.docker.com/engine/install/) on your system and ensure its available on your command line. Additionally, install the `VSCode Containers Extension <vscode:extension/ms-vscode-remote.remote-containers>`_.
Configuring and setting up the :code:`Dockerfile` as well the configuration for the devcontainer can be a bit more involved. The good thing is you don't have to do it. Usually it should be enough to install `Docker <https://docs.docker.com/engine/install/>`_ on your system and ensure its available on your command line. Additionally, install the `VSCode Containers Extension <vscode:extension/ms-vscode-remote.remote-containers>`_.

Now you should be good to go. When starting VSCode, it will ask you to run in the container environment and - if you confirm - automatically build the container and use it. To manually instruct VSCode to use the devcontainer, you can, after installing the extension, click the green area in the bottom left corner of your VSCode window and select the option *(Re)Open Folder in Container*.

Expand Down
2 changes: 1 addition & 1 deletion doc/source/contributor-how-to-write-documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Project layout

The Flower documentation lives in the ``doc`` directory. The Sphinx-based documentation system supports both reStructuredText (``.rst`` files) and Markdown (``.md`` files).

Note that, in order to build the documentation locally (with ``poetry run make html``, like described below), `Pandoc <https://pandoc.org/installing.html>_` needs to be installed on the system.
Note that, in order to build the documentation locally (with ``poetry run make html``, like described below), `Pandoc <https://pandoc.org/installing.html>`_ needs to be installed on the system.


Edit an existing page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ but you can change it by providing a specific :code:`<version>`)::

$ ./dev/venv-create.sh <version>

If you don't have :code:`pyenv` installed,
you can use the following script that will install pyenv,
If you don't have :code:`pyenv` installed,
you can use the following script that will install pyenv,
set it up and create the virtual environment (with :code:`Python 3.8.17` by default)::

$ ./dev/setup-defaults.sh <version>
Expand Down Expand Up @@ -83,7 +83,7 @@ Run Github Actions (CI) locally
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Developers could run the full set of Github Actions workflows under their local
environment by using `Act <https://github.com/nektos/act>_`. Please refer to
environment by using `Act <https://github.com/nektos/act>`_. Please refer to
the installation instructions under the linked repository and run the next
command under Flower main cloned repository folder::

Expand Down Expand Up @@ -116,6 +116,6 @@ convenience script to re-build the documentation yet, but it's pretty easy::

This will generate HTML documentation in ``doc/build/html``.

Note that, in order to build the documentation locally
(with ``poetry run make html``, like described below),
`Pandoc <https://pandoc.org/installing.html>_` needs to be installed on the system.
Note that, in order to build the documentation locally
(with ``poetry run make html``, like described below),
`Pandoc <https://pandoc.org/installing.html>`_ needs to be installed on the system.