Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove doc version value #2260

Merged
merged 2 commits into from
Jul 5, 2022
Merged
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
25 changes: 13 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,20 @@ variable. The ``-W`` option turns all warnings into errors::

SPHINXOPTS=-W make clean html


Auto-generated content
----------------------

Some parts of the OMERO documentation are auto-generated from the OMERO
deliverables (e.g. templates, command-line output...). This auto-generation is
usually done via Continuous Integration builds. To generate these components
manually, download the OMERO.server and run the auto-generation script as::

WORSKSPACE=/path/to/OMERO/deliverables ./omero/autogen_docs

***************
Release process
---------------
***************

This repository uses `bump2version <https://pypi.org/project/bump2version/>`_ to manage version numbers.
To tag a release run::
Expand All @@ -134,17 +146,6 @@ To switch back to a development version run::
Specifying ``major``, ``minor`` or ``patch`` depending on whether the development branch will be a `major, minor or patch release <https://semver.org/>`_. This will also add the ``SNAPSHOT`` suffix.
jburel marked this conversation as resolved.
Show resolved Hide resolved



Auto-generated content
----------------------

Some parts of the OMERO documentation are auto-generated from the OMERO
deliverables (e.g. templates, command-line output...). This auto-generation is
usually done via Continuous Integration builds. To generate these components
manually, download the OMERO.server and run the auto-generation script as::

WORSKSPACE=/path/to/OMERO/deliverables ./omero/autogen_docs

****************
Conventions Used
****************
Expand Down