Merged in refactor/RAM-3539_hatchling (pull request #380)

Refactor/RAM-3539 hatchling

Approved-by: Randy Taylor

.readthedocs.yaml

@@ -9,11 +9,14 @@ sphinx:
 #   - pdf
 
 # Optionally set the version of Python and requirements required to build your docs
-python:
-   install:
-   - requirements: requirements-rtd.txt
+#python:
+#   install:
+#   - requirements: requirements-rtd.txt
 
 build:
    os: ubuntu-22.04
    tools:
       python: "3.11"
+   jobs:
+      post_install:
+         - pip install .[docs]

bitbucket-pipelines.yml

@@ -21,7 +21,7 @@ definitions:
           - apt-get update
           - python -m venv venv
           - source venv/bin/activate
-          - pip install -r requirements-dev.txt
+          - pip install .[dev]
           - pip freeze
         artifacts:
           - venv/**
@@ -278,7 +278,7 @@ pipelines:
               - apt-get update
               - python -m venv venv
               - source venv/bin/activate
-              - pip install -r requirements-dev.txt
+              - pip install .[dev]
             artifacts:
               - venv/**
       - step:

docs/source/conf.py

@@ -83,9 +83,11 @@
 # built documents.
 #
 # The short X.Y version.
-version = "3.22"
+from pylinac.version import __version__  # noqa
+
+version = ".".join(__version__.split(".")[:-1])  # chop off patch number
 # The full version, including alpha/beta/rc tags.
-release = "3.22.0"
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/contributing.rst

@@ -54,7 +54,7 @@ Be sure to ask for help if you need it!
 * Clone your `forked repository to your local machine <https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository>`__: ``git clone`` followed by the URL of your forked repository.
   Some IDEs also have a GUI for this. See also :ref:`distro_stack`.
 * Create a virtual environment. This is optional but highly recommended. See the `Python guide <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/>`__ to set up a new venv.
-* Install the requirements and developer requirements: ``pip install -r requirements.txt -r requirements-dev.txt``
+* Install the requirements and developer requirements: ``pip install .[dev]``
 * Create a new branch for your work: ``git checkout -b my_new_branch``
 * Make your changes
 * Write tests for your changes. Most test modules in pylinac have a 1:1 correlation with the library modules and thus the

docs/source/installation.rst

@@ -18,17 +18,7 @@ Great! To get started install via pip:
 
 .. note::
 
-    Installing from source (``setup.py install``) is possible but not recommended as downloading the source includes numerous sizable test files.
-
-.. _dependencies:
-
-Dependencies
-------------
-
-Pylinac, as a scientific package, has fairly standard scientific dependencies (>= means at least that version or newer).
-Installing the package via ``pip`` will install these for you:
-
-.. literalinclude:: ../../requirements.txt
+    If you plan on developing or contributing to pylinac, you'll want to set up a development environment. See :ref:`setup_dev_env`.
 
 I'm new to Python
 -----------------