Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Clone docs for gh pages * Added nojekyll * Update the docs * Add new commands to the docs Makefile * Change the way classes are displayed * Follow the docs repo- removed library * Whitelist for versioning * Change the docstring parsing style (still numpy, but a different extension and change the directory for clean git in the Makefile (I do not want to accidentally delete it) * Add placeholders for the readme and contribution guidelines * Add theory page * Add theory to the docs * Add more recipes to the Makefile, for making docs * Remove cleaning recipes, since they do not work, and are not needed anyway * Changes from docs * Modify targers * Add the theory rst (so as people do not have to pandoc, before make html) * Sphinx gallery * Add a readme for the functioning and structure of docs. Correct command in Makefile * Commit the updated docs and add the gallery folders to git in the Makefille * Ignore the output from sphinx-gallery, generated locally (to commit, move it to /docs) * Exclude docs from flake8 * Remove docs as a submodule, change the directory of the docs folder * Add scipy to intersphinx links * New structure in the rst index * Delete gallery-generated files * Add versioning * Refactor index * Add creating a global index * Push the new commit to origin * Reproduce the structure of the landing page * Change the title in the documented classes and functions * Fix images submodule, and add contributions pages * Add release notes, the example by Lewis, add afaq * Add the rst faq file * Try nbsphinx * delete unused readme and theory * Correct the command for staging all changes in the docs,modify the import to cover the case where the examples are executedfrom a different directory * Correct the start-after for examples, comment unnecessary ocnfig lines in conf * Add mapper pipeline scheme in thedocs * Work on the toctree structure (failed) * Add a layout with a redirection link in the footer * Add currentmodule scope when generating sphinx-doc for gtda.utils, add notebooks * Adapt the Makefile to also work on CI (allow the variables to be set externally * Add azureidentity for git operations * Change the nesting in yml CI * Do not keep track of the glossary.rst * Add strategy nesting in CI, silence remove glossary error and download picture if does not exist * Add the python version to CI * Add cache dir to variablles * Unindent all of the steps in CI * Correct git interactionsi nCI * Correct indentation of azure * Temporarily disabledownloading the token * Correct the path of the figure * Make jupyter notebooks display correctly in the docs * Add before glossary, to get the right headings * Ignore the incorporated notebooks and python files * Add references, from the docstrings to the theory page * Unify the beginning of notebooks in examples,so as to import the beginning in rst files * Remove old notebooks readme * Correct reference to the voids on the plane notebook * Modify the output in mapper-quickstart * Restructure the hierarchy * Change the hierarchy for the installation part * Change link in the layout (still does not work?) and add the github url as metadata * Change the add changes command for the gtda-docs repo * Introduce a new index and toctree structure * Modify the structure,to get expandable items * Introduce a vietorisRips quickstart * Add notebooks to the new ghpages structure, in two categories: basiic and advanceds * Add examples,change references, work on the installation docs * Correct the programatic staging of files in the docs repo * Modify the docstrings in classes * Reduce warnings on sphinx * Reduce warnings with class templates * Change location of the logo, suppress templates warnings * Add the header required by pandoc for glossary * Suppress warning for before_glossarynotincluded in toctrees * Restructure the contributing documentation, add description of the doc infstrastrucure * Change reference to dev installation and dealwith a no-new-line compilation warning * Add the dev_installation and index files, for the new structure of contributing * Add a prune-the-current-version target inthe makefile * Modify the faq to something more official * Prune the donc conf file and add dependencies in the doc setup (anddev) * Add openml to docs dependencies, and document depending on pandoc * Add steps to check if the dependencies are installed correctly, before deleting everything from the clone * Modify the docs CI stepo * Correct the setup dependencies * Fix some typos in the rst and tex - looking through the html * Correct the layout in examples, move examples to use cases, rearange contributing * Add a list of versions, add a target to statically fetch the available versions in the repo * Detect the version automatically AND add it in the menu.Clean solution * Correct indentation in the pipelines config file * Use the pushing target from the Makefile to push the documentation in the pipeline. Add a printout on make html * Fix the pipeline url and prune CONTRIBUTING.rst * Actually stage the changes of the contributing file * Change the directory for cloning in azure * Correct the pipeline linebreak syntax * Change cloninig of gtdadocs from ssh to https * Correct typo in password variable * Reomve pushing to gtda-docs from makefile targets * Disable failonStderr for git clone * Correct GITDIR in pipelines * Fix linting * Wording changes in CONTRIBUTING.rst * Update the previous versions with the currently compiled one * Remove the .txt extension in sources for html files * Remove failing on stdErr for generating noteebooks in CI and go back to 'stable' in the default version of docs generation * Modify the push url in CI * Add --repo option, capitalize variable * Use quotes * Add a section explaining the versioning in the docs * Use ssh keys instead to push to gtda-docs * Add logo to images * Define the pipelines to use wreise/sphinx_rtd_theme * Add installing the theme dependency in the docs * Point to secure file on Azure * Update ccache key * Modify the windows dev installation instructions * Modify how the installation is displayed * Replace mapper pipeline svg, improve make_mapper_pipeline docstring * Remove colons from subsection names in glossary * Linting and fixing broken links in docstrings * Point to GH pages from README.rst * Remove the documentation ci (temporarily) * Update ccache * Fix environment problem in vietoris_rips_quickstart.ipynb * Set the kernel to default in mapper_quickstart * Clarify the sphinx_rtd_theme setup in contributing/index.rst * Remove building docs in ci * Add boost installation troubleshooting explanations * Reintroduce PlotterMixin inheritance in VietorisRipsPersistence Co-authored-by: Umberto <u.lupo@l2f.ch> Co-authored-by: Umberto Lupo <46537483+ulupo@users.noreply.github.com>
- Loading branch information
3 people
committed
Mar 12, 2020
1 parent
f464a77
commit 6586676