Merge pull request #233 from ledatelescope/update-docs

Update docs

.github/workflows/main.yml

@@ -59,7 +59,7 @@ jobs:
       - name: "Software Install - Python"
         run: python -m pip install \
                setuptools \
-               numpy \
+               "numpy<2" \
                matplotlib \
                contextlib2 \
                simplejson \
@@ -119,7 +119,7 @@ jobs:
           UNITTEST_OS: ${{ matrix.os }}
           UNITTEST_PY: ${{ matrix.python-version }}
         if: ${{ matrix.os == 'self-hosted' && matrix.python-version == '3.8' }}
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v4
         with:
           files: ./test/coverage.xml, ./testbench/coverage.xml
           env_vars: UNITTEST_OS,UNITTEST_PY

CHANGELOG

@@ -8,6 +8,7 @@
  * Added set_stream and get_stream to bifrost.device to help control which CUDA stream is used
  * Added bifrost.device.ExternalStream as a context manager to help with mixing Bifrost and cupy/pycuda
  * Fixed a problem calling bifrost.reduce on a slice of an array
+ * Added the astype() method to `bifrost.ndarray`
 
 0.10.0
  * Switched over to an autotools-based build system

Makefile.in

@@ -7,8 +7,12 @@ DAT_DIR = share
 SRC_DIR = src
 
 HAVE_PYTHON = @HAVE_PYTHON@
+
 HAVE_DOCKER = @HAVE_DOCKER@
 
+CAN_BUILD_CXX_DOCS = @HAVE_CXX_DOCS@
+CAN_BUILD_PYTHON_DOCS = @HAVE_PYTHON_DOCS@
+
 BIFROST_PYTHON_DIR = python
 
 all: libbifrost python
@@ -63,8 +67,13 @@ ifeq ($(HAVE_PYTHON),1)
 endif
 .PHONY: uninstall
 
-doc: $(INC_DIR)/bifrost/*.h Doxyfile
+doc: $(INC_DIR)/bifrost/*.h Doxyfile docs/source/*.rst docs/source/*.py
+ifeq ($(CAN_BUILD_CXX_DOCS),1)
 	@DX_DOXYGEN@ Doxyfile
+endif
+ifeq ($(CAN_BUILD_PYTHON_DOCS),1)
+	$(MAKE) -C docs singlehtml
+endif
 .PHONY: doc
 
 python: libbifrost

README.md

@@ -97,8 +97,12 @@ go to the following [link](https://colab.research.google.com/github/ledatelescop
 
 ### C Dependencies
 
+If using Ubuntu or another Debian-based linux distribution:
+
     $ sudo apt-get install exuberant-ctags
 
+Otherwise check https://ctags.sourceforge.net/ for install instructions.
+
 ### Python Dependencies
 
  * numpy
@@ -171,8 +175,17 @@ your machine.
 
 ### Building the Docs from Scratch
 
-Install sphinx and breathe using pip, and also install Doxygen.
+Install breathe using pip:
+
+    $ sudo pip install breathe sphinx
+
+Also install Doxygen using your package manager. 
+In Ubuntu, for example:
+
+    $ sudo apt-get install doxygen
 
+Otherwise check https://www.doxygen.nl/ for Doxygen install instructions.
+
 Doxygen documentation can be generated by running:
 
     $ make doc