Skip to content

Commit d613aa7

Browse files
authored
Doc enhance with enum, and automated link repairs for the dev site [3rd] (#1226)
* fix enum type for units * fix the 404s
1 parent 759f86d commit d613aa7

File tree

309 files changed

+309
-377865
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

309 files changed

+309
-377865
lines changed

guide/01-getting-started/install-and-set-up.ipynb

Lines changed: 1 addition & 580 deletions
Large diffs are not rendered by default.

guide/01-getting-started/install-older-versions.ipynb

Lines changed: 1 addition & 499 deletions
Large diffs are not rendered by default.
Lines changed: 1 addition & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -1,135 +1 @@
1-
{
2-
"cells": [
3-
{
4-
"cell_type": "markdown",
5-
"metadata": {},
6-
"source": [
7-
"# System requirements"
8-
]
9-
},
10-
{
11-
"cell_type": "markdown",
12-
"metadata": {
13-
"toc": true
14-
},
15-
"source": [
16-
"<h1>Table of Contents<span class=\"tocSkip\"></span></h1>\n",
17-
"<div class=\"toc\"><ul class=\"toc-item\"><li><span><a href=\"#System-requirements\" data-toc-modified-id=\"System-requirements-1\"><span class=\"toc-item-num\">1&nbsp;&nbsp;</span>System requirements</a></span><ul class=\"toc-item\"><li><span><a href=\"#Operating-System\" data-toc-modified-id=\"Operating-System-1.1\"><span class=\"toc-item-num\">1.1&nbsp;&nbsp;</span>Operating System</a></span></li><li><span><a href=\"#Python-Version\" data-toc-modified-id=\"Python-Version-1.2\"><span class=\"toc-item-num\">1.2&nbsp;&nbsp;</span>Python Version</a></span></li><li><span><a href=\"#Dependencies\" data-toc-modified-id=\"Dependencies-1.3\"><span class=\"toc-item-num\">1.3&nbsp;&nbsp;</span>Dependencies</a></span><ul class=\"toc-item\"><li><span><a href=\"#Optional-Dependencies\" data-toc-modified-id=\"Optional-Dependencies-1.3.1\"><span class=\"toc-item-num\">1.3.1&nbsp;&nbsp;</span>Optional Dependencies</a></span></li></ul></li></ul></li></ul></div>"
18-
]
19-
},
20-
{
21-
"cell_type": "markdown",
22-
"metadata": {},
23-
"source": [
24-
"## Operating System \n",
25-
"The ArcGIS API for Python is compatible with 32-bit and 64-bit versions of Windows, macOS, and Linux.\n",
26-
"\n",
27-
"## Python Version\n",
28-
"Python 3.5 or later is required to use the ArcGIS API for Python.\n",
29-
"\n",
30-
"## Dependencies\n",
31-
"The full power of the ArcGIS API for Python is best experienced when all its dependencies are installed. However, specific tasks such as GIS administration and content management can be accomplished with just the [`six`](https://pypi.python.org/pypi/six) package installed. See [Install without Dependencies](../install-and-set-up/#Install-without-Dependencies) to install the `arcgis` package in this manner.\n",
32-
"\n",
33-
"It is recommended to install the `arcgis` package the default way of either `conda install -c esri arcgis` or `pipenv install arcgis`. When installed in this manner, all the below dependencies are automatically installed. Note that most of these packages have dependencies of their own.\n",
34-
"\n",
35-
"* [six](https://pypi.python.org/pypi/six)\n",
36-
"* [pandas>=1.3.5](https://pandas.pydata.org/) \n",
37-
"* [numpy>=1.16.2](http://www.numpy.org/) \n",
38-
"* [pyshp>=2](https://pypi.python.org/pypi/pyshp/) \n",
39-
"* [matplotlib](https://matplotlib.org/)\n",
40-
"* [notebook](https://ipython.org/notebook.html)\n",
41-
"* [ipywidgets >=7](https://ipywidgets.readthedocs.io/en/stable/)\n",
42-
"* [widgetsnbextension >=3](https://pypi.python.org/pypi/widgetsnbextension)\n",
43-
"* [keyring>=23.3.*](https://pypi.python.org/pypi/keyring/10.6.0)\n",
44-
"* [winkerberos](https://pypi.python.org/pypi/winkerberos/0.7.0) (Windows only)\n",
45-
"* [urllib3](https://pypi.python.org/pypi/urllib3)\n",
46-
"* [cachetools](https://pypi.org/project/cachetools/)\n",
47-
"* [lxml](https://pypi.org/project/lxml/)\n",
48-
"* [cryptography](https://pypi.org/project/cryptography/)\n",
49-
"* [jupyter-client<=6.1.12](https://pypi.org/project/jupyter-client/)\n",
50-
"* [jupyterlab](https://pypi.org/project/jupyterlab/)\n",
51-
"* [lerc](https://pypi.org/project/lerc/)\n",
52-
"* [ujson>=3](https://pypi.org/project/ujson/)\n",
53-
"* [python-certifi-win32](https://pypi.org/project/python-certifi-win32/)\n",
54-
"* [pywin32>=223](https://pypi.org/project/pywin32/) (Windows only)\n",
55-
"* [geomet](https://pypi.org/project/geomet/)\n",
56-
"* [requests>=1.27.1](https://pypi.org/project/requests/)\n",
57-
"* [requests-oauthlib](https://pypi.org/project/requests-oauthlib/)\n",
58-
"* [requests_toolbelt](https://pypi.org/project/requests_toolbelt/)\n",
59-
"* [requests_ntlm](https://pypi.org/project/requests_ntlm/)\n",
60-
"* [requests-gssapi](https://pypi.org/project/requests-gssapi/)\n",
61-
"* [requests-negotiate-sspi](https://pypi.org/project/requests-negotiate-sspi/) (Windows only)\n",
62-
"* [requests-kerberos](https://pypi.org/project/requests-kerberos/) (Windows only)\n",
63-
"\n",
64-
"> Note: if `arcpy` is found in the current python environment, it may be used in various locations. Otherwise, `pyshp` will be used. See [Spatially Enabled DataFrame](https://developers.arcgis.com/python/api-reference/arcgis.features.toc.html?highlight=geoaccessor#arcgis.features.GeoAccessor) for more information.\n",
65-
"\n",
66-
"### Optional Dependencies\n",
67-
"\n",
68-
"There are some other python packages that may be required to use certain functionality in the API, but are __not__ automatically installed. To use that functionality, you must manually call `conda install {package_name}` or `pipenv install {package_name}` for such optional packages."
69-
]
70-
}
71-
],
72-
"metadata": {
73-
"kernelspec": {
74-
"display_name": "Python 3 (ipykernel)",
75-
"language": "python",
76-
"name": "python3"
77-
},
78-
"language_info": {
79-
"codemirror_mode": {
80-
"name": "ipython",
81-
"version": 3
82-
},
83-
"file_extension": ".py",
84-
"mimetype": "text/x-python",
85-
"name": "python",
86-
"nbconvert_exporter": "python",
87-
"pygments_lexer": "ipython3",
88-
"version": "3.7.11"
89-
},
90-
"toc": {
91-
"base_numbering": 1,
92-
"nav_menu": {},
93-
"number_sections": true,
94-
"sideBar": true,
95-
"skip_h1_title": false,
96-
"title_cell": "Table of Contents",
97-
"title_sidebar": "Contents",
98-
"toc_cell": true,
99-
"toc_position": {},
100-
"toc_section_display": true,
101-
"toc_window_display": true
102-
},
103-
"varInspector": {
104-
"cols": {
105-
"lenName": 16,
106-
"lenType": 16,
107-
"lenVar": 40
108-
},
109-
"kernels_config": {
110-
"python": {
111-
"delete_cmd_postfix": "",
112-
"delete_cmd_prefix": "del ",
113-
"library": "var_list.py",
114-
"varRefreshCmd": "print(var_dic_list())"
115-
},
116-
"r": {
117-
"delete_cmd_postfix": ") ",
118-
"delete_cmd_prefix": "rm(",
119-
"library": "var_list.r",
120-
"varRefreshCmd": "cat(var_dic_list()) "
121-
}
122-
},
123-
"types_to_exclude": [
124-
"module",
125-
"function",
126-
"builtin_function_or_method",
127-
"instance",
128-
"_Feature"
129-
],
130-
"window_display": false
131-
}
132-
},
133-
"nbformat": 4,
134-
"nbformat_minor": 1
135-
}
1+
{"cells": [{"cell_type": "markdown", "metadata": {}, "source": ["# System requirements"]}, {"cell_type": "markdown", "metadata": {"toc": true}, "source": ["<h1>Table of Contents<span class=\"tocSkip\"></span></h1>\n", "<div class=\"toc\"><ul class=\"toc-item\"><li><span><a href=\"#System-requirements\" data-toc-modified-id=\"System-requirements-1\"><span class=\"toc-item-num\">1&nbsp;&nbsp;</span>System requirements</a></span><ul class=\"toc-item\"><li><span><a href=\"#Operating-System\" data-toc-modified-id=\"Operating-System-1.1\"><span class=\"toc-item-num\">1.1&nbsp;&nbsp;</span>Operating System</a></span></li><li><span><a href=\"#Python-Version\" data-toc-modified-id=\"Python-Version-1.2\"><span class=\"toc-item-num\">1.2&nbsp;&nbsp;</span>Python Version</a></span></li><li><span><a href=\"#Dependencies\" data-toc-modified-id=\"Dependencies-1.3\"><span class=\"toc-item-num\">1.3&nbsp;&nbsp;</span>Dependencies</a></span><ul class=\"toc-item\"><li><span><a href=\"#Optional-Dependencies\" data-toc-modified-id=\"Optional-Dependencies-1.3.1\"><span class=\"toc-item-num\">1.3.1&nbsp;&nbsp;</span>Optional Dependencies</a></span></li></ul></li></ul></li></ul></div>"]}, {"cell_type": "markdown", "metadata": {}, "source": ["## Operating System \n", "The ArcGIS API for Python is compatible with 32-bit and 64-bit versions of Windows, macOS, and Linux.\n", "\n", "## Python Version\n", "Python 3.5 or later is required to use the ArcGIS API for Python.\n", "\n", "## Dependencies\n", "The full power of the ArcGIS API for Python is best experienced when all its dependencies are installed. However, specific tasks such as GIS administration and content management can be accomplished with just the [`six`](https://pypi.python.org/pypi/six) package installed. See [Install without Dependencies](../install-and-set-up/#Install-without-Dependencies) to install the `arcgis` package in this manner.\n", "\n", "It is recommended to install the `arcgis` package the default way of either `conda install -c esri arcgis` or `pipenv install arcgis`. When installed in this manner, all the below dependencies are automatically installed. Note that most of these packages have dependencies of their own.\n", "\n", "* [six](https://pypi.python.org/pypi/six)\n", "* [pandas>=1.3.5](https://pandas.pydata.org/) \n", "* [numpy>=1.16.2](http://www.numpy.org/) \n", "* [pyshp>=2](https://pypi.python.org/pypi/pyshp/) \n", "* [matplotlib](https://matplotlib.org/)\n", "* [notebook](https://ipython.org/notebook.html)\n", "* [ipywidgets >=7](https://ipywidgets.readthedocs.io/en/stable/)\n", "* [widgetsnbextension >=3](https://pypi.python.org/pypi/widgetsnbextension)\n", "* [keyring>=23.3.*](https://pypi.python.org/pypi/keyring/10.6.0)\n", "* [winkerberos](https://pypi.python.org/pypi/winkerberos/0.7.0) (Windows only)\n", "* [urllib3](https://pypi.python.org/pypi/urllib3)\n", "* [cachetools](https://pypi.org/project/cachetools/)\n", "* [lxml](https://pypi.org/project/lxml/)\n", "* [cryptography](https://pypi.org/project/cryptography/)\n", "* [jupyter-client<=6.1.12](https://pypi.org/project/jupyter-client/)\n", "* [jupyterlab](https://pypi.org/project/jupyterlab/)\n", "* [lerc](https://pypi.org/project/lerc/)\n", "* [ujson>=3](https://pypi.org/project/ujson/)\n", "* [python-certifi-win32](https://pypi.org/project/python-certifi-win32/)\n", "* [pywin32>=223](https://pypi.org/project/pywin32/) (Windows only)\n", "* [geomet](https://pypi.org/project/geomet/)\n", "* [requests>=1.27.1](https://pypi.org/project/requests/)\n", "* [requests-oauthlib](https://pypi.org/project/requests-oauthlib/)\n", "* [requests_toolbelt](https://pypi.org/project/requests_toolbelt/)\n", "* [requests_ntlm](https://pypi.org/project/requests_ntlm/)\n", "* [requests-gssapi](https://pypi.org/project/requests-gssapi/)\n", "* [requests-negotiate-sspi](https://pypi.org/project/requests-negotiate-sspi/) (Windows only)\n", "* [requests-kerberos](https://pypi.org/project/requests-kerberos/) (Windows only)\n", "\n", "> Note: if `arcpy` is found in the current python environment, it may be used in various locations. Otherwise, `pyshp` will be used. See [Spatially Enabled DataFrame](https://developers.arcgis.com/python/api-reference/arcgis.features.toc.html?highlight=geoaccessor#arcgis.features.GeoAccessor) for more information.\n", "\n", "### Optional Dependencies\n", "\n", "There are some other python packages that may be required to use certain functionality in the API, but are __not__ automatically installed. To use that functionality, you must manually call `conda install {package_name}` or `pipenv install {package_name}` for such optional packages."]}], "metadata": {"kernelspec": {"display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3"}, "language_info": {"codemirror_mode": {"name": "ipython", "version": 3}, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.7.11"}, "toc": {"base_numbering": 1, "nav_menu": {}, "number_sections": true, "sideBar": true, "skip_h1_title": false, "title_cell": "Table of Contents", "title_sidebar": "Contents", "toc_cell": true, "toc_position": {}, "toc_section_display": true, "toc_window_display": true}, "varInspector": {"cols": {"lenName": 16, "lenType": 16, "lenVar": 40}, "kernels_config": {"python": {"delete_cmd_postfix": "", "delete_cmd_prefix": "del ", "library": "var_list.py", "varRefreshCmd": "print(var_dic_list())"}, "r": {"delete_cmd_postfix": ") ", "delete_cmd_prefix": "rm(", "library": "var_list.r", "varRefreshCmd": "cat(var_dic_list()) "}}, "types_to_exclude": ["module", "function", "builtin_function_or_method", "instance", "_Feature"], "window_display": false}}, "nbformat": 4, "nbformat_minor": 1}

0 commit comments

Comments
 (0)