Skip to content

Commit

Permalink
Try to fix RTD modules again
Browse files Browse the repository at this point in the history
  • Loading branch information
peterbrittain committed Oct 23, 2023
1 parent a492f02 commit 03e60e9
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yaml
Expand Up @@ -25,3 +25,4 @@ sphinx:
python:
install:
- requirements: requirements.txt
- path: .
6 changes: 3 additions & 3 deletions doc/source/contributing.rst
Expand Up @@ -39,7 +39,7 @@ Install the dependencies and build the documentation with:
.. code-block:: bash
$ pip install -r requirements/dev.txt
$ cd doc && cp source/conf_orig.py source/conf.py
$ cd doc
$ ./build.sh
You can then view your new shiny documentation in the ``build`` folder.
Expand All @@ -52,14 +52,14 @@ Install the dependencies and run the tests with the following:
.. code-block:: bash
$ pip install -r requirements/dev.txt
$ nosetests
$ python -m unittest
On most systems this will avoid running tests that require a Linux TTY. If you are making changes to the
Screen, you must also run the TTY tests. You can force that on a Linux box using the following:

.. code-block:: bash
$ FORCE_TTY=Y nosetests
$ FORCE_TTY=Y python -m unittest
The reason for this split is that you only typically get a TTY on a live interactive connection to your
terminal. This means you should always be able to run the full suite manually. However, many CI systems
Expand Down
7 changes: 1 addition & 6 deletions setup.py
Expand Up @@ -11,14 +11,9 @@
from os import path
import shutil

with file_open("./doc/source/conf_orig.py", "r") as src:
with file_open("./doc/source/conf.py", "w") as dst:
dst.write("# FILE COPIED FROM conf_orig.py; DO NOT CHANGE\n")
shutil.copyfileobj(src, dst)

here = path.abspath(path.dirname(__file__))

# Get the long description from the relevant file and strip any pre-amble (i.e. badges) from it.
here = path.abspath(path.dirname(__file__))
with file_open(path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read().split("\n")
while long_description[0] not in ("ASCIIMATICS", "ASCIIMATICS\r"):
Expand Down

0 comments on commit 03e60e9

Please sign in to comment.