diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 124074b06..8817c8da8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,12 +31,13 @@ jobs: run: echo ::set-output name=tag::${GITHUB_REF#refs/*/} - name: env setup run: | - python -m pip install graphviz nbsite sphinx_holoviz_theme "nbconvert <=5.3.1" + python -m pip install graphviz myst_parser pydata-sphinx-theme "nbconvert <6.0" "myst-nb" + python -m pip install nbsite --pre python -m pip install -e . - name: build docs run: | - python -m nbsite generate-rst --org pyviz --repo param --project-name param mkdir doc/Reference_Manual && nbsite_generate_modules.py param -d ./doc/Reference_Manual -n param -e tests + cp examples/user_guide/*.ipynb doc/user_guide/ python -m nbsite build --examples-assets='' --org holoviz --project-name param - name: Deploy dev uses: peaceiris/actions-gh-pages@v3 diff --git a/doc/Reference_Manual/index.rst b/doc/Reference_Manual/index.rst deleted file mode 100644 index f0a1520e9..000000000 --- a/doc/Reference_Manual/index.rst +++ /dev/null @@ -1,97 +0,0 @@ -******************** -API Reference Manual -******************** - -The Param API Reference Manual provides a comprehensive reference for -all methods and objects available from Param. For human-readable guides to -how to use these capabilities, see the `User Guide <../user_guide>`_. - -Module Structure -________________ - - -`param package <#param-package>`_ - Collection of Parameter objects to use in your code -`param.parameterized module <#parameterized-module>`_ - Definition for core Param components: Parameter and Parameterized, plus utilities -`param.serializer module <#serializer-module>`_ - Optional support for serializing to JSON or other formats -`param.ipython module <#ipython-module>`_ - Optional ipython support -`numbergen package <#numbergen-numbergen-package>`_ - Separate package with generators for streams of numeric values - - ---------- - -:mod:`param` Package --------------------- - -.. inheritance-diagram:: param.__init__ - - -.. automodule:: param.__init__ - :members: - :inherited-members: - :show-inheritance: - -------- - -:mod:`parameterized` Module ---------------------------- - -.. inheritance-diagram:: param.parameterized - - -.. automodule:: param.parameterized - :members: - :inherited-members: - :show-inheritance: - -------- - -:mod:`serializer` Module ------------------------- - -.. inheritance-diagram:: param.serializer - - -.. automodule:: param.serializer - :members: - :inherited-members: - :show-inheritance: - -------- - -:mod:`ipython` Module ---------------------- - -.. inheritance-diagram:: param.ipython - - -.. automodule:: param.ipython - :members: - :inherited-members: - :show-inheritance: - -------- - - - -:mod:`numbergen` Package ------------------------- - -.. inheritance-diagram:: numbergen.__init__ - - -.. automodule:: numbergen.__init__ - :members: - :inherited-members: - :show-inheritance: - -------- - -.. toctree:: - :maxdepth: 2 - :hidden: - diff --git a/doc/conf.py b/doc/conf.py index 3735b0af6..8de23df1d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -13,7 +13,7 @@ param.parameterized.docstring_signature = False param.parameterized.docstring_describe_params = False -extensions.append("myst_parser") +extensions += ["myst_nb"] nbbuild_cell_timeout = 600 diff --git a/doc/user_guide/Simplifying_Codebases.rst b/doc/user_guide/Simplifying_Codebases.rst deleted file mode 100644 index 66f8b5abb..000000000 --- a/doc/user_guide/Simplifying_Codebases.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. - Originally generated by nbsite (0.6.8a29): - /Users/jbednar/miniconda3/envs/test-environment/bin/nbsite generate-rst --org holoviz --project-name param --skip ^.*homepage.*$ - Will not subsequently be overwritten by nbsite, so can be edited. - -********************* -Simplifying Codebases -********************* - -.. notebook:: param ../../examples/user_guide/Simplifying_Codebases.ipynb - :offset: 0 - - -------- - -`Right click to download this notebook from GitHub. `_ diff --git a/doc/user_guide/index.md b/doc/user_guide/index.md index a02004e87..878967294 100644 --- a/doc/user_guide/index.md +++ b/doc/user_guide/index.md @@ -15,5 +15,6 @@ This user guide provides a detailed introduction to the API and features of Para --- hidden: true --- +Overview Simplifying Codebases ``` diff --git a/setup.py b/setup.py index 3087382b9..33dac0d6b 100644 --- a/setup.py +++ b/setup.py @@ -27,7 +27,8 @@ def get_setup_version(reponame): 'nbsite >=0.6.1', 'pydata-sphinx-theme', 'myst-parser', - 'nbconvert <0.6' + 'nbconvert <6.0', + 'myst_nb' ] }