diff --git a/docs/source/index.rst b/docs/source/index.rst index 98e14bd844..39bd46a5c3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,46 +1,58 @@ .. EvalAI documentation master file, created by - sphinx-quick start on Fri Jul 14 11:32:35 2017. + sphinx-quickstart on Fri Jul 14 11:32:35 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to EvalAI's documentation! ================================== - EvalAI_ is an open source platform for evaluating and comparing machine learning (ML) and artificial intelligence algorithms (AI) at scale. - It is built to provide a scalable solution to the research community to fulfill the critical need of evaluating machine learning models and agents acting in an environment against annotations or with a human-in-the-loop. Contents: .. toctree:: :maxdepth: 2 + :caption: ๐Ÿงช Getting Started 01-getting-started/README + +.. toctree:: + :maxdepth: 2 + :caption: ๐ŸŽฏ Hosting a Challenge + 02-for-challenge-hosts/README + +.. toctree:: + :maxdepth: 2 + :caption: ๐Ÿš€ Participating in Challenges + 03-for-participants/README + +.. toctree:: + :maxdepth: 2 + :caption: โš™๏ธ Developer Guide + 04-development/README - 05-api-reference/README + +.. toctree:: + :maxdepth: 2 + :caption: ๐Ÿ“– Examples & Tutorials + 06-examples-tutorials/README + +.. toctree:: + :maxdepth: 2 + :caption: ๐Ÿ› ๏ธ Troubleshooting + 07-troubleshooting/README + +.. toctree:: + :maxdepth: 2 + :caption: ๐Ÿ“š Reference + + 05-api-reference/README 08-reference/README - .. github_based_challenge_setup - .. configuration - .. evaluation_scripts - .. edit_evaluation_script - .. approve_challenge - .. participate - .. make_submission_public_private_baseline - .. pull_request - .. contribution - .. architecture - .. architecture_decisions - .. directory_structure - .. submission - .. migrations - .. cite - .. faq(developers) - .. glossary Indices and tables ==================