External links are not duplicated, few warnings less

Now we have 2 files and the main (the one we want to send people to) is `api.html`, not `index.html`.
golemfactory · Sep 16, 2021 · ee649c0 · ee649c0
1 parent a470b31
commit ee649c0
Show file tree

Hide file tree

Showing 2 changed files with 127 additions and 124 deletions.
diff --git a/docs/sphinx/api.rst b/docs/sphinx/api.rst
@@ -0,0 +1,125 @@
+
+**************************
+Golem Python API Reference
+**************************
+
+
+Golem
+=====
+
+.. autoclass:: yapapi.Golem
+    :members: __init__, execute_tasks, run_service, create_network
+
+
+Task API
+========
+
+Task
+----
+
+.. autoclass:: yapapi.Task
+    :members: __init__, running_time, accept_result, reject_result
+
+Service API
+===========
+
+Service
+-------
+
+.. autoclass:: yapapi.services.Service
+    :members: id, provider_name, state, is_available, start, run, shutdown, send_message, send_message_nowait, receive_message, receive_message_nowait, get_payload
+
+Cluster
+-------
+
+.. autoclass:: yapapi.services.Cluster
+    :members:
+
+ServiceState
+------------
+
+.. autoclass:: yapapi.services.ServiceState
+
+Network API
+===========
+
+Network
+-------
+
+.. autoclass:: yapapi.network.Network
+    :members: __init__, create, owner_ip, network_address, netmask, gateway, nodes_dict, network_id, add_owner_address, add_node,
+
+.. autoclass:: yapapi.network.Node
+    :members: network, node_id, ip, get_deploy_args
+
+.. autoclass:: yapapi.network.NetworkError
+
+Payload definition
+==================
+
+Payload
+-------
+
+.. autoclass:: yapapi.payload.Payload
+
+Package
+-------
+
+.. autoclass:: yapapi.payload.package.Package
+
+
+vm.repo
+-------
+
+.. automodule:: yapapi.payload.vm
+    :members: repo
+
+
+Execution control
+=================
+
+WorkContext
+-----------
+
+.. autoclass:: yapapi.WorkContext
+    :members: id, provider_name, provider_id, new_script, get_raw_usage, get_usage, get_raw_state, get_cost
+
+Script
+------
+
+.. autoclass:: yapapi.script.Script
+    :members: __init__, id, add, deploy, start, terminate, run, download_bytes, download_file, download_json, upload_bytes, upload_file, upload_json
+
+
+Market strategies
+==========================
+
+.. autoclass:: yapapi.strategy.MarketStrategy
+    :members: decorate_demand, score_offer
+
+.. autoclass:: yapapi.strategy.DummyMS
+
+.. autoclass:: yapapi.strategy.LeastExpensiveLinearPayuMS
+
+.. autoclass:: yapapi.strategy.DecreaseScoreForUnconfirmedAgreement
+
+Exceptions
+==========
+
+.. autoexception:: yapapi.NoPaymentAccountError
+
+.. autoexception:: yapapi.rest.activity.BatchTimeoutError
+
+Logging
+=======
+
+.. automodule:: yapapi.log
+    :members: enable_default_logger, log_summary, SummaryLogger
+
+
+Utils
+=====
+
+.. autofunction:: yapapi.windows_event_loop_fix
+
+.. autofunction:: yapapi.get_version
diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst
@@ -3,131 +3,9 @@ Golem Python API Reference
 **************************
 
 .. toctree::
-    :maxdepth: 4
-    :hidden:
 
-    index
+    api
+
     Golem Handbook <https://handbook.golem.network/>
     Github <https://github.com/golemfactory/yapapi>
     Pypi <https://pypi.org/project/yapapi/>
-
-
-Golem
-=====
-
-.. autoclass:: yapapi.Golem
-    :members: __init__, execute_tasks, run_service, create_network
-
-
-Task API
-========
-
-Task
-----
-
-.. autoclass:: yapapi.Task
-    :members: __init__, running_time, accept_result, reject_result
-
-Service API
-===========
-
-Service
--------
-
-.. autoclass:: yapapi.services.Service
-    :members: id, provider_name, state, is_available, start, run, shutdown, send_message, send_message_nowait, receive_message, receive_message_nowait, get_payload
-
-Cluster
--------
-
-.. autoclass:: yapapi.services.Cluster
-    :members:
-
-ServiceState
-------------
-
-.. autoclass:: yapapi.services.ServiceState
-
-Network API
-===========
-
-Network
--------
-
-.. autoclass:: yapapi.network.Network
-    :members: __init__, create, owner_ip, network_address, netmask, gateway, nodes_dict, network_id, add_owner_address, add_node,
-
-.. autoclass:: yapapi.network.Node
-    :members: network, node_id, ip, get_deploy_args
-
-.. autoclass:: yapapi.network.NetworkError
-
-Payload definition
-==================
-
-Payload
--------
-
-.. autoclass:: yapapi.payload.Payload
-
-Package
--------
-
-.. autoclass:: yapapi.payload.package.Package
-
-
-vm.repo
--------
-
-.. automodule:: yapapi.payload.vm
-    :members: repo
-
-
-Execution control
-=================
-
-WorkContext
------------
-
-.. autoclass:: yapapi.WorkContext
-    :members: id, provider_name, provider_id, new_script, get_raw_usage, get_usage, get_raw_state, get_cost
-
-Script
-------
-
-.. autoclass:: yapapi.script.Script
-    :members: __init__, id, add, deploy, start, terminate, run, download_bytes, download_file, download_json, upload_bytes, upload_file, upload_json
-
-
-Market strategies
-==========================
-
-.. autoclass:: yapapi.strategy.MarketStrategy
-    :members: decorate_demand, score_offer
-
-.. autoclass:: yapapi.strategy.DummyMS
-
-.. autoclass:: yapapi.strategy.LeastExpensiveLinearPayuMS
-
-.. autoclass:: yapapi.strategy.DecreaseScoreForUnconfirmedAgreement
-
-Exceptions
-==========
-
-.. autoexception:: yapapi.NoPaymentAccountError
-
-.. autoexception:: yapapi.rest.activity.BatchTimeoutError
-
-Logging
-=======
-
-.. automodule:: yapapi.log
-    :members: enable_default_logger, log_summary, SummaryLogger
-
-
-Utils
-=====
-
-.. autofunction:: yapapi.windows_event_loop_fix
-
-.. autofunction:: yapapi.get_version