Skip to content

Commit f2a7271

Browse files
authored
DOCS-2653: Fix links in Modin's documentation (#2654)
Signed-off-by: Alexey Prutskov <alexey.prutskov@intel.com>
1 parent 09d7c18 commit f2a7271

File tree

9 files changed

+26
-46
lines changed

9 files changed

+26
-46
lines changed

docs/UsingSQLonRay/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Our plans with the SQL API for Modin are to create an interface that allows you
1010
intermix SQL and pandas operations without copying the entire dataset into a new
1111
structure between the two. This is possible due to the architecture of Modin. Currently,
1212
Modin has a query compiler that acts as an intermediate layer between the query language
13-
(e.g. SQL, pandas) and the execution (See architecture_ documentation for details).
13+
(e.g. SQL, pandas) and the execution (See :doc:`architecture </developer/architecture>` documentation for details).
1414

1515
*We have implemented a simple example that can be found below. Feedback welcome!*
1616

@@ -29,5 +29,3 @@ Modin has a query compiler that acts as an intermediate layer between the query
2929
col1 col2 column 3 col4
3030
0 1 2.0 A String of information True
3131
1 6 17.0 A String of different information False
32-
33-
.. _architecture: https://modin.readthedocs.io/en/latest/developer/architecture.html

docs/contributing.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ If you're interested in getting involved in the development of Modin, but aren't
88
where start, take a look at the issues tagged `Good first issue`_ or Documentation_.
99
These are issues that would be good for getting familiar with the codebase and better
1010
understanding some of the more complex components of the architecture. There is
11-
documentation here about the architecture_ that you will want to review in order to get
12-
started.
11+
documentation here about the :doc:`architecture </developer/architecture>` that you will
12+
want to review in order to get started.
1313

1414
Also, feel free to join the discussions on the `developer mailing list`_.
1515

@@ -143,7 +143,7 @@ Adding a test
143143

144144
If you find yourself fixing a bug or adding a new feature, don't forget to add a test to
145145
the test suite to verify its correctness! More on testing and the layout of the tests
146-
can be found in our testing_ documentation. We ask that you follow the existing
146+
can be found in our testing documentation. We ask that you follow the existing
147147
structure of the tests for ease of maintenance.
148148

149149
Running the tests
@@ -214,6 +214,7 @@ Some details about using Modin on Ray with Asv:
214214
Some details for maintenance:
215215

216216
* ``modin/asv_bench/asv.conf.json`` contains the modin dependencies, with which testing takes place.
217+
217218
We need to keep them up to date according to the dependencies in ``setup.py``.
218219

219220

@@ -241,7 +242,7 @@ Contributing a new execution framework or in-memory format
241242
----------------------------------------------------------
242243

243244
If you are interested in contributing support for a new execution framework or in-memory
244-
format, please make sure you understand the architecture_ of Modin.
245+
format, please make sure you understand the :doc:`architecture </developer/architecture>` of Modin.
245246

246247
The best place to start the discussion for adding a new execution framework or in-memory
247248
format is the `developer mailing list`_.
@@ -250,11 +251,8 @@ More docs on this coming soon...
250251

251252
.. _Good first issue: https://github.com/modin-project/modin/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue+%3Abeginner%3A%22
252253
.. _Documentation: https://github.com/modin-project/modin/issues?q=is%3Aissue+is%3Aopen+label%3A%22documentation+%3Abookmark_tabs%3A%22
253-
.. _architecture: architecture.html
254-
.. _internal methods:
255254
.. _black: https://github.com/ambv/black
256255
.. _flake8: http://flake8.pycqa.org/en/latest/
257256
.. _Github Actions: https://github.com/features/actions
258-
.. _testing:
259257
.. _Asv: https://github.com/airspeed-velocity/asv#airspeed-velocity
260258
.. _developer mailing list: https://groups.google.com/forum/#!forum/modin-dev

docs/developer/architecture.rst

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -234,27 +234,23 @@ Supported Execution Frameworks and Memory Formats
234234

235235
This is the list of execution frameworks and memory formats supported in Modin. If you
236236
would like to contribute a new execution framework or memory format, please see the
237-
documentation page on :doc:`../contributing`.
237+
documentation page on :doc:`contributing </contributing>`.
238238

239-
- `Pandas on Ray`_
239+
- :doc:`Pandas on Ray </UsingPandasonRay/index>`
240240
- Uses the Ray_ execution framework.
241241
- The compute kernel/in-memory format is a pandas DataFrame.
242-
- `Pandas on Dask`_
242+
- :doc:`Pandas on Dask </UsingPandasonDask/index>`
243243
- Uses the `Dask Futures`_ execution framework.
244244
- The compute kernel/in-memory format is a pandas DataFrame.
245-
- `Pyarrow on Ray`_ (experimental)
245+
- :doc:`Pyarrow on Ray </UsingPyarrowonRay/index>` (experimental)
246246
- Uses the Ray_ execution framework.
247247
- The compute kernel/in-memory format is a pyarrow Table.
248248

249-
.. _pandas Dataframe: https://pandas.pydata.org/pandas-docs/version/0.23.4/generated/pandas.DataFrame.html
249+
.. _pandas Dataframe: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html
250250
.. _Arrow tables: https://arrow.apache.org/docs/python/generated/pyarrow.Table.html
251251
.. _Ray: https://github.com/ray-project/ray
252252
.. _code: https://github.com/modin-project/modin/blob/master/modin/engines/base/frame/data.py
253-
.. _Contributing: contributing.html
254-
.. _Pandas on Ray: UsingPandasonRay/optimizations.html
255-
.. _Pandas on Dask: UsingPandasonDask/optimizations.html
256253
.. _Dask Futures: https://docs.dask.org/en/latest/futures.html
257254
.. _issue: https://github.com/modin-project/modin/issues
258255
.. _Discourse: https://discuss.modin.org
259256
.. _task parallel: https://en.wikipedia.org/wiki/Task_parallelism
260-
.. _Pyarrow on Ray: UsingPyarrowonRay/index.html

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,6 @@ nature, you get a fast DataFrame at 1MB and 1TB+.
170170
troubleshooting
171171
contact
172172

173-
.. _Dataframe: https://pandas.pydata.org/pandas-docs/version/0.23.4/generated/pandas.DataFrame.html
173+
.. _Dataframe: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html
174174
.. _Ray: https://github.com/ray-project/ray/
175175
.. _Dask: https://dask.org/

docs/installation.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ You may already have a recent version of Dask_ installed, in which case you can
8484
Building Modin from Source
8585
--------------------------
8686

87-
If you're planning on contributing_ to Modin, you will need to ensure that you are
87+
If you're planning on :doc:`contributing </contributing>` to Modin, you will need to ensure that you are
8888
building Modin from the local repository that you are working off of. Occasionally,
8989
there are issues in overlapping Modin installs from pypi and from source. To avoid these
9090
issues, we recommend uninstalling Modin before you install from source:
@@ -109,8 +109,6 @@ Once cloned, ``cd`` into the ``modin`` directory and use ``pip`` to install:
109109
110110
.. _`GitHub repo`: https://github.com/modin-project/modin/tree/master
111111
.. _issue: https://github.com/modin-project/modin/issues
112-
.. _`out of core`: out_of_core.html
113112
.. _WSL: https://docs.microsoft.com/en-us/windows/wsl/install-win10
114113
.. _Ray: http://ray.readthedocs.io
115-
.. _contributing: contributing.html
116114
.. _Dask: https://github.com/dask/dask

docs/out_of_core.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Install Modin out of core
1010
-------------------------
1111

1212
Modin now comes with all the dependencies for out of core functionality by default! See
13-
the `installation page`_ for more information on installing Modin.
13+
the :doc:`installation page </installation>` for more information on installing Modin.
1414

1515
Starting Modin with out of core enabled
1616
---------------------------------------
@@ -62,5 +62,4 @@ This example creates a 40GB DataFrame from 20 identical 2GB DataFrames and perfo
6262
various operations on them. Feel free to play around with this code and let us know what
6363
you think!
6464

65-
.. _Dataframe: https://pandas.pydata.org/pandas-docs/version/0.23.4/generated/pandas.DataFrame.html
66-
.. _`installation page`: installation.html
65+
.. _Dataframe: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html

docs/supported_apis/index.rst

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ For your convenience, we have compiled a list of currently implemented APIs and
55
available in Modin. This documentation is updated as new methods and APIs are merged
66
into the master branch, and not necessarily correct as of the most recent release. In
77
order to install the latest version of Modin, follow the directions found on the
8-
`installation page`_.
8+
:doc:`installation page </installation>`.
99

1010
Questions on implementation details
1111
-----------------------------------
@@ -33,20 +33,15 @@ Modin.
3333

3434
The exact methods we have implemented are listed in the respective subsections:
3535

36-
* DataFrame_
37-
* Series_
38-
* utilities_
39-
* `I/O`_
36+
* :doc:`DataFrame </supported_apis/dataframe_supported>`
37+
* :doc:`Series </supported_apis/series_supported>`
38+
* :doc:`utilities </supported_apis/utilities_supported>`
39+
* :doc:`I/O </supported_apis/io_supported>`
4040

4141
We have taken a community-driven approach to implementing new methods. We did a `study
4242
on pandas usage`_ to learn what the most-used APIs are. Modin currently supports **93%**
4343
of the pandas API based on our study of pandas usage, and we are actively expanding the
4444
API.
4545

46-
.. _DataFrame: dataframe_supported.html
47-
.. _Series: series_supported.html
48-
.. _utilities: utilities_supported.html
49-
.. _I/O: io_supported.html
50-
.. _study on pandas usage: https://github.com/modin-project/study_kaggle_usage
5146
.. _`developer mailing list`: https://groups.google.com/forum/#!forum/modin-dev
52-
.. _`installation page`: installation.html#building-modin-from-source
47+
.. _`study on pandas usage`: https://github.com/modin-project/study_kaggle_usage

docs/supported_apis/series_supported.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The second column is a flag for whether or not there is an implementation in Mod
1111
the method in the left column. ``Y`` stands for yes, ``N`` stands for no, ``P`` stands
1212
for partial (meaning some parameters may not be supported yet), and ``D`` stands for
1313
default to pandas. To learn more about the implementations that default to pandas, see
14-
the related section on `Defaulting to pandas`_.
14+
the related section on :doc:`Defaulting to pandas </supported_apis/index>`.
1515

1616
+-----------------------------+---------------------------------+----------------------------------------------------+
1717
| Series method | Modin Implementation? (Y/N/P/D) | Notes for Current implementation |
@@ -487,4 +487,3 @@ the related section on `Defaulting to pandas`_.
487487
+-----------------------------+---------------------------------+----------------------------------------------------+
488488

489489
.. _`GitHub repository`: https://github.com/modin-project/modin/issues
490-
.. _`Defaulting to pandas`: index.html

docs/using_modin.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Using Modin on a Single Node
2424
**In local (without a cluster) modin will create and manage a local (dask or ray) cluster for the execution**
2525

2626
In order to use the most up-to-date version of Modin, please follow the instructions on
27-
the `installation page`_
27+
the :doc:`installation page </installation>`.
2828

2929
Once you import the library, you should see something similar to the following output:
3030

@@ -52,7 +52,7 @@ Please note, the API is not yet complete. For some methods, you may see the foll
5252
5353
NotImplementedError: To contribute to Modin, please visit github.com/modin-project/modin.
5454
55-
We have compiled a list of `currently supported methods`_.
55+
We have compiled a list of :doc:`currently supported methods </supported_apis/index>`.
5656

5757
If you would like to request a particular method be implemented, feel free to `open an
5858
issue`_. Before you open an issue please make sure that someone else has not already
@@ -90,7 +90,7 @@ you can customize your Ray environment for use in Modin!
9090
Exceeding memory (Out of core pandas)
9191
"""""""""""""""""""""""""""""""""""""
9292

93-
Modin experimentally supports out of core operations. See more on the `Out of Core`_
93+
Modin experimentally supports out of core operations. See more on the :doc:`Out of Core </out_of_core>`
9494
documentation page.
9595

9696
Reducing or limiting the resources Modin can use
@@ -134,13 +134,10 @@ Examples
134134
You can find an example on our recent `blog post`_ or on the `Jupyter Notebook`_ that we
135135
used to create the blog post.
136136

137-
.. _`DataFrame`: https://pandas.pydata.org/pandas-docs/version/0.23.4/generated/pandas.DataFrame.html
137+
.. _`DataFrame`: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html
138138
.. _`pandas`: https://pandas.pydata.org/pandas-docs/stable/
139-
.. _`installation page`: https://modin.readthedocs.io/en/latest/installation.html
140-
.. _`currently supported methods`: https://modin.readthedocs.io/en/latest/pandas_supported.html
141139
.. _`open an issue`: https://github.com/modin-project/modin/issues
142140
.. _`autoscaler documentation`: https://ray.readthedocs.io/en/latest/autoscaling.html
143141
.. _`Ray's documentation`: https://ray.readthedocs.io/en/latest/api.html
144142
.. _`blog post`: https://rise.cs.berkeley.edu/blog/pandas-on-ray-early-lessons/
145143
.. _`Jupyter Notebook`: https://gist.github.com/devin-petersohn/f424d9fb5579a96507c709a36d487f24#file-pandas_on_ray_blog_post_0-ipynb
146-
.. _`Out of Core`: out_of_core.html

0 commit comments

Comments
 (0)