Develop (#50)

* add collections array to the entrypoint

* add default manages block

* allow configurable collection names

* fix tests and pep8 format

* add entrypoint property to the apidoc

* add example of manages block in sample

* fix id literal

* fix id literal and generate sample doc

* Add support for POST and DELETE on collection classes (#46)

* Add support for POST and DELETE on collection classes

As the collection will now be treated as a resource,
we need to add support for POST and DELETE on collection/:uuid endpoint

* Default readable and writable attributes of member property to True

* Fix PEP8 errors

* Discover collections in doc_maker.py (#41)

* remove hardcoding of Collection keyword

Remove hardcoding of "Collection" keyword for checking if
a class is a collection. Check either using 'collection'
property defined in 'EntryPoint' or 'manages' property defined
in that class

* Fix tests

Use get_endpoint_and_path function instead of class_in_endpoint
or collection_in_endpoint as they are changed to get_endpoint_and_path
function

* Remove dependency of class collection (#45)

* add method for adding HydraCollection

* Remove dependency of collection on classes 🎉

* Remove unnecessary comments

* add missing context

* Bring class uris to the apidoc url namespace
* Give user option to chose the location of the apidoc
* Make sure identifiers are inside the apidoc namespace

* fix ids of supported Operations

* Expansion of JSONLD and parsing of API DOC (#42)

* [WIP] expand jsonld and use hydra namespace

* Extract endpoint classes and collections

* add comments

* Store Link ids in the endpoints.

* make HydraClass for classes endpoints

* finish parsing of expanded apidoc 🎉

* Write new tests

* resolve conflicts, make minor changes

* add ids for base classes,

* Add Docs (#47)

* add docs with sphinx

* add readthedocs yml and requirements.txt

* change version

* change sys.path

* Bug Fixes (#48)

* Add the namespace test and fix test due to adding of new manages block

* Add base classes just once

* place instantation at the right place

* Case sensitive URLs

* fix tests

* avoid rewriting of the collections array

* Parse HydraLinks in context

* entrypoint uri correct

Co-authored-by: Priyanshu Nayan <priyanshunayan456@gmail.com>
Co-authored-by: Samesh Lakhotia <43701530+sameshl@users.noreply.github.com>

.readthedocs.yml

@@ -0,0 +1,10 @@
+version: 1
+build:
+  image: latest
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  version: 3.6
+  install:
+    - requirements: requirements.txt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'hydra-python-core'
+copyright = '2020, Hydra'
+author = 'Hydra'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+source_suffix = '.rst'
+master_doc = 'index'
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/source/doc_maker.rst

@@ -0,0 +1,8 @@
+
+
+doc_maker
+=============================================
+
+.. automodule:: hydra_python_core.doc_maker
+   :members:
+

docs/source/doc_writer.rst

@@ -0,0 +1,9 @@
+
+
+doc_writer
+=============================================
+
+.. automodule:: hydra_python_core.doc_writer
+   :members:
+
+

docs/source/index.rst

@@ -0,0 +1,20 @@
+
+
+Welcome to hydra-python-core's documentation!
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   doc_writer
+   doc_maker
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`