Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ docs/_build/
docs/src/generated/
docs/src/sg_execution_times.rst
tools/documentation_developer/CONTRIBUTING.rst
tools/documentation_developer/CONTRIBUTORS.rst
docs/src/whats_news/CHANGELOG.rst

# file generated by hatch
src/hidimstat/_version.py
Expand Down
2 changes: 0 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _changes:

=================================
Version 1.1 (under devellopement)
=================================
Expand Down
6 changes: 5 additions & 1 deletion CONTRIBUTOR.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
Version 0.1.0 (see https://github.com/ja-che/hidimstat)
-------------------------------------------------------
https://github.com/ja-che
https://github.com/tbng
https://github.com/agramfort
https://github.com/GuillaumeFavelier

Version 0.1.1 (see https://github.com/Parietal-INRIA/hidimstat)
---------------------------------------------------------------
https://github.com/tbng
https://github.com/bthirion
https://github.com/achamma723

Version 0.2.0
-------------
https://github.com/tbng
https://github.com/bthirion
https://github.com/achamma723

Version 1.0.0
Version 1.0.0
-------------
https://github.com/bthirion
https://github.com/AngelReyero
https://github.com/jpaillard
Expand Down
3 changes: 3 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ clean:
rm -rfv $(BUILDDIR)/*
rm -rfv $(SOURCEDIR)/generated/*
rm -rfv $(SOURCEDIR)/sg_execution_times.rst
rm -rfv $(SOURCEDIR)/whats_news/CHANGELOG.rst
rm -rfv $(SOURCEDIR)/dev/CONTRIBUTING.rst
rm -rfv $(SOURCEDIR)/dev/CONTRIBUTORS.rst

html-noplot:
$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
Expand Down
1 change: 1 addition & 0 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,5 @@ References
user_guide
generated/gallery/examples/index
glossary_and_notations
whats_news/whats_news
dev/index
Empty file.
3 changes: 3 additions & 0 deletions docs/src/whats_news/v1.0.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
==============
Version 1.0.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Version 1.0.0
Version 0.3.0
```We're not ready for a 1.0.0 yet

==============
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,20 @@ Latest modification
.. _latest:
.. include:: latest.rst

.. _changelog:
.. include:: CHANGELOG.rst


=======================
History of modification
=======================

.. _v1.0.0:
.. include:: v1.0.0.rst
.. include:: v1.0.0.rst

.. toctree::
:hidden:
:maxdepth: 1

v1.0.0
latest
2 changes: 0 additions & 2 deletions docs/tools/_templates/CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _changes:

=================================
Version X.Y.Z (under devellopement)
=================================
Expand Down
2 changes: 2 additions & 0 deletions docs/tools/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
# We avoid duplicating the information, but we do not use symlinks to be
# able to build the docs on Windows
shutil.copyfile("../../CONTRIBUTING.rst", "../src/dev/CONTRIBUTING.rst")
shutil.copyfile("../../CONTRIBUTOR.rst", "../src/dev/CONTRIBUTORS.rst")
shutil.copyfile("../../CHANGELOG.rst", "../src/whats_news/CHANGELOG.rst")

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
7 changes: 7 additions & 0 deletions tools/documentation_developer/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,17 @@ You need more information, look here:
- :ref:`Continuous Integration<developer_documentation_CI>`
- :ref:`Building the documentation<developer_documentation_build>`

============
CONTRIBUTORS
============
.. _latest:
.. include:: CONTRIBUTORS.rst

.. toctree::
:hidden:

developer_guidelines
how_to_contribute
building_documentation
CI_documentation
CONTRIBUTORS