diff --git a/README.md b/README.md index 045dffb..1529d39 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ The ANTs unbiased template construction method consists of the iterative applica In particular, brainglobe-template-builder uses an optimised version of the [antsMultivariateTemplateConstruction2.sh](https://github.com/ANTsX/ANTs/blob/master/Scripts/antsMultivariateTemplateConstruction2.sh) script. This optimised implementation was developed by the [CoBra lab](https://www.cobralab.ca/) and is available through the [optimized_antsMultivariateTemplateConstruction GitHub repository](https://github.com/CoBrALab/optimized_antsMultivariateTemplateConstruction/tree/master). ## License -⚖️ [BSD 3-Clause](./LICENSE) +⚖️ [BSD 3-Clause](https://opensource.org/license/bsd-3-clause/) ## Template This package layout and configuration (including pre-commit hooks and GitHub actions) have been copied from the [python-cookiecutter](https://github.com/neuroinformatics-unit/python-cookiecutter) template. diff --git a/docs/source/api_index.rst b/docs/source/api_index.rst deleted file mode 100644 index 8e8a2ed..0000000 --- a/docs/source/api_index.rst +++ /dev/null @@ -1,2 +0,0 @@ -API -=== diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md deleted file mode 100644 index bac959d..0000000 --- a/docs/source/getting_started.md +++ /dev/null @@ -1,11 +0,0 @@ -# Getting started - -Here you may demonstrate the basic functionalities your package. - -You can include code snippets using the usual Markdown syntax: - -```python -from my_package import my_function - -result = my_function() -``` diff --git a/docs/source/index.rst b/docs/source/index.rst index 4cb1e5f..08ec07c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,44 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to brainglobe-template-builder's documentation! -========================================================= -.. toctree:: - :maxdepth: 2 - :caption: Contents: +.. include:: ../../README.md + :parser: myst_parser.sphinx_ - getting_started - api_index - -By default the documentation includes the following sections: - -* Getting started. Here you could describe the basic functionalities of your package. To modify this page, edit the file ``docs/source/getting_started.md``. -* API: here you can find the auto-generated documentation of your package, which is based on the docstrings in your code. To modify which modules/classes/functions are included in the API documentation, edit the file ``docs/source/api_index.rst``. - -You can create additional sections with narrative documentation, -by adding new ``.md`` or ``.rst`` files to the ``docs/source`` folder. -These files shoult start with a level-1 (H1) header, -which will be used as the section title. Sub-sections can be created -with lower-level headers (H2, H3, etc.) within the same file. - -To include a section in the rendered documentation, -add it to the ``toctree`` directive in this (``docs/source/index.rst``) file. - -For example, you could create a ``docs/source/installation.md`` file -and add it to the ``toctree`` like this: - -.. code-block:: rst - - .. toctree:: - :maxdepth: 2 - :caption: Contents: - - getting_started - installation - api_index - -Index & Search --------------- -* :ref:`genindex` -* :ref:`search`