add placeholder in docs directory

astro-datalab · Dec 12, 2024 · 1172005 · 1172005
1 parent 8860aee
commit 1172005
Show file tree

Hide file tree

Showing 3 changed files with 105 additions and 83 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -1,4 +1,3 @@
-# Workflow is based on the Astropy GitHub actions workflow, ci_workflows.yml
 name: CI
 
 on:
@@ -10,91 +9,91 @@ on:
     pull_request:
 
 jobs:
-    tests:
-        name: Unit tests
-        runs-on: ${{ matrix.os }}
-        strategy:
-            fail-fast: true
-            matrix:
-                os: [ubuntu-latest]
-                # numpy-version: ['<1.19', '<1.20', '>=1.20']
-                python-version: ['3.9', '3.10', '3.11']
-                astropy-version: ['<6.0', '<6.1', '<7.0']
+    # tests:
+    #     name: Unit tests
+    #     runs-on: ${{ matrix.os }}
+    #     strategy:
+    #         fail-fast: true
+    #         matrix:
+    #             os: [ubuntu-latest]
+    #             # numpy-version: ['<1.19', '<1.20', '>=1.20']
+    #             python-version: ['3.9', '3.10', '3.11', '3.12']
+    #             astropy-version: ['<6.0', '<6.1', '<7.0']
 
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v4
-              with:
-                fetch-depth: 0
-            - name: Set up Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v5
-              with:
-                python-version: ${{ matrix.python-version }}
-            - name: Install Python dependencies
-              run: |
-                python -m pip install --upgrade pip setuptools wheel
-                python -m pip install pytest pyyaml jinja2 numpy\<2.0
-                python -m pip install "astropy${{ matrix.astropy-version }}"
-            - name: Run the test
-              run: pytest
+    #     steps:
+    #         - name: Checkout code
+    #           uses: actions/checkout@v4
+    #           with:
+    #             fetch-depth: 0
+    #         - name: Set up Python ${{ matrix.python-version }}
+    #           uses: actions/setup-python@v5
+    #           with:
+    #             python-version: ${{ matrix.python-version }}
+    #         - name: Install Python dependencies
+    #           run: |
+    #             python -m pip install --upgrade pip setuptools wheel
+    #             python -m pip install pytest pyyaml jinja2 numpy\<2.0
+    #             python -m pip install "astropy${{ matrix.astropy-version }}"
+    #         - name: Run the test
+    #           run: pytest
 
-    coverage:
-        name: Test coverage
-        runs-on: ${{ matrix.os }}
-        strategy:
-            fail-fast: false
-            matrix:
-                os: [ubuntu-latest]
-                python-version: ['3.10']
-                astropy-version: ['<6.1']
+    # coverage:
+    #     name: Test coverage
+    #     runs-on: ${{ matrix.os }}
+    #     strategy:
+    #         fail-fast: false
+    #         matrix:
+    #             os: [ubuntu-latest]
+    #             python-version: ['3.9']
+    #             astropy-version: ['<6.1']
 
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v4
-              with:
-                fetch-depth: 0
-            - name: Set up Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v5
-              with:
-                python-version: ${{ matrix.python-version }}
-            - name: Install Python dependencies
-              run: |
-                python -m pip install --upgrade pip setuptools wheel
-                python -m pip install pytest pyyaml jinja2 numpy\<2.0 pytest-cov coveralls
-                python -m pip install --upgrade "astropy${{ matrix.astropy-version }}"
-            - name: Run the test with coverage
-              run: pytest --cov
-            - name: Coveralls
-              # uses: coverallsapp/[email protected]
-              # with:
-              #     github-token: ${{ secrets.GITHUB_TOKEN }}
-              env:
-                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-                COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
-              run: coveralls
+    #     steps:
+    #         - name: Checkout code
+    #           uses: actions/checkout@v4
+    #           with:
+    #             fetch-depth: 0
+    #         - name: Set up Python ${{ matrix.python-version }}
+    #           uses: actions/setup-python@v5
+    #           with:
+    #             python-version: ${{ matrix.python-version }}
+    #         - name: Install Python dependencies
+    #           run: |
+    #             python -m pip install --upgrade pip setuptools wheel
+    #             python -m pip install pytest pyyaml jinja2 numpy\<2.0 pytest-cov coveralls
+    #             python -m pip install --upgrade "astropy${{ matrix.astropy-version }}"
+    #         - name: Run the test with coverage
+    #           run: pytest --cov
+    #         - name: Coveralls
+    #           # uses: coverallsapp/[email protected]
+    #           # with:
+    #           #     github-token: ${{ secrets.GITHUB_TOKEN }}
+    #           env:
+    #             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    #             COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+    #           run: coveralls
 
-    docs:
-        name: Doc test
-        runs-on: ${{ matrix.os }}
-        strategy:
-            fail-fast: false
-            matrix:
-                os: [ubuntu-latest]
-                python-version: ['3.10']
+    # docs:
+    #     name: Doc test
+    #     runs-on: ${{ matrix.os }}
+    #     strategy:
+    #         fail-fast: false
+    #         matrix:
+    #             os: [ubuntu-latest]
+    #             python-version: ['3.9']
 
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v4
-              with:
-                fetch-depth: 0
-            - name: Set up Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v5
-              with:
-                python-version: ${{ matrix.python-version }}
-            - name: Install Python dependencies
-              run: python -m pip install --upgrade pip setuptools wheel Sphinx
-            - name: Test the documentation
-              run: sphinx-build -W --keep-going -b html docs docs/_build/html
+    #     steps:
+    #         - name: Checkout code
+    #           uses: actions/checkout@v4
+    #           with:
+    #             fetch-depth: 0
+    #         - name: Set up Python ${{ matrix.python-version }}
+    #           uses: actions/setup-python@v5
+    #           with:
+    #             python-version: ${{ matrix.python-version }}
+    #         - name: Install Python dependencies
+    #           run: python -m pip install --upgrade pip setuptools wheel Sphinx
+    #         - name: Test the documentation
+    #           run: sphinx-build -W --keep-going -b html docs docs/_build/html
 
     style:
         name: Style check
@@ -103,7 +102,7 @@ jobs:
             fail-fast: false
             matrix:
                 os: [ubuntu-latest]
-                python-version: ['3.10']
+                python-version: ['3.9']
 
         steps:
             - name: Checkout code
@@ -119,4 +118,4 @@ jobs:
             - name: Test the style
               # This is equivalent to an allowed falure.
               # continue-on-error: true
-              run: pycodestyle --count digestor
+              run: pycodestyle --count dlairflow
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,15 @@
+=============
+dlairflow API
+=============
+
+.. automodule:: dlairflow
+    :members:
+
+.. automodule:: dlairflow.base
+    :members:
+
+.. automodule:: dlairflow.sdss
+    :members:
+
+.. automodule:: dlairflow.view
+    :members:
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -0,0 +1,8 @@
+====================
+dlairflow Change Log
+====================
+
+0.1.0 (unreleased)
+------------------
+
+* *Planned*: simply get a working Python package.