Skip to content

Commit

Permalink
Merge pull request #9 from LSSTDESC/issue/6/no-docs
Browse files Browse the repository at this point in the history
Remove all the docs
  • Loading branch information
delucchi-cmu authored Jun 12, 2023
2 parents 4c6d418 + 3e21a79 commit 8ba27cf
Show file tree
Hide file tree
Showing 36 changed files with 1 addition and 1,818 deletions.
26 changes: 1 addition & 25 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ jobs:
--data use_isort=false
--data mypy_type_checking=basic
--data create_example_module=no
--data include_notebooks=no
--data use_gitlfs=disabled
foldername: 'black_w_o_example_module'
- name: Black w/ example
Expand All @@ -46,7 +45,6 @@ jobs:
--data use_isort=false
--data mypy_type_checking=basic
--data create_example_module=yes
--data include_notebooks=no
--data use_gitlfs=disabled
foldername: 'black_w_example_module'
- name: Pylint w/o example
Expand All @@ -61,17 +59,8 @@ jobs:
--data use_isort=false
--data mypy_type_checking=basic
--data create_example_module=no
--data include_notebooks=no
--data use_gitlfs=disabled
foldername: 'pylint_w_o_example_module'
- name: No sphinx docs
package_name: 'drewtonian'
extra_flags: >-
--data project_name=new_science
--data package_name=drewtonian
--data include_docs=no
--data include_notebooks=no
foldername: 'no_sphinx_docs'

steps:

Expand Down Expand Up @@ -125,20 +114,7 @@ jobs:
run: |
cd "../test/${{ matrix.copier_config.foldername }}"
mypy --strict src tests
- name: Install notebook requirements
if: ${{ !contains(matrix.copier_config.extra_flags, 'include_notebooks=no') }}
run: |
sudo apt-get install pandoc
pip install -r ../test/${{ matrix.copier_config.foldername }}/docs/requirements.txt
cat ../test/${{ matrix.copier_config.foldername }}/docs/requirements.txt
- name: Build docs
if: ${{ !contains(matrix.copier_config.extra_flags, 'include_docs=no') }}
run: |
cd ../test/${{ matrix.copier_config.foldername }}
sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html
- name: Tests
if: ${{ !contains(matrix.copier_config.extra_flags, 'create_example_module=no') }}
run: |
Expand Down
22 changes: 0 additions & 22 deletions .readthedocs.yml

This file was deleted.

18 changes: 0 additions & 18 deletions copier.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,24 +81,6 @@ create_example_module:
no: false
when: "{{ custom_install }}"

include_docs:
help: Do you want to include a directory for sphinx, and autoapi generation?
type: bool
default: yes
choices:
yes: true
no: false
when: "{{ custom_install }}"

include_notebooks:
help: Do you want to include rendered notebooks in your documentation?
type: bool
default: yes
choices:
yes: true
no: false
when: "{{ custom_install and include_docs }}"

use_gitlfs:
help: Do you want to add a .gitattributes with entries for git-lfs (see https://lincc-ppt.readthedocs.io/en/latest/practices/git-lfs.html)?
type: str
Expand Down
21 changes: 0 additions & 21 deletions docs/Makefile

This file was deleted.

35 changes: 0 additions & 35 deletions docs/conf.py

This file was deleted.

39 changes: 0 additions & 39 deletions docs/index.rst

This file was deleted.

31 changes: 0 additions & 31 deletions docs/practices/ci_testing.rst

This file was deleted.

24 changes: 0 additions & 24 deletions docs/practices/code_coverage.rst

This file was deleted.

131 changes: 0 additions & 131 deletions docs/practices/git-lfs.rst

This file was deleted.

Loading

0 comments on commit 8ba27cf

Please sign in to comment.