Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #348

Merged
merged 16 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,7 @@ help:

TOPTARGETS := all html clean

SUBDIRS = diagrams

$(TOPTARGETS): $(SUBDIRS)
$(SUBDIRS):
$(MAKE) -C $@ $(MAKECMDGOALS)

.PHONY: $(TOPTARGETS) $(SUBDIRS)
.PHONY: $(TOPTARGETS)

.PHONY: html
html:
Expand All @@ -36,8 +30,3 @@ clean:
$(RM) _build/
$(RM) _autosummary/


# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile $(SUBDIRS)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
3 changes: 0 additions & 3 deletions docs/basic_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ Using Firecrown
.. role:: python(code)
:language: python




The easiest way to get started using Firecrown is to look at the examples.
These are found in the `examples folder <https://github.com/LSSTDESC/firecrown/tree/master/examples>`_.
There are examples that show use of each of the supported samplers.
Expand Down
5 changes: 5 additions & 0 deletions docs/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ Testing
As the coverage improves, we will provide instructions for writing tests for new code.

We are using :bash:`pytest` to run tests on Firecrown.
To run the same set of tests that will be run by the CI system, use:

.. code:: bash

python -m pytest

Use of :bash:`pylint`
---------------------
Expand Down
52 changes: 0 additions & 52 deletions docs/diagrams.rst

This file was deleted.

39 changes: 0 additions & 39 deletions docs/diagrams/GNUmakefile

This file was deleted.

49 changes: 0 additions & 49 deletions docs/diagrams/gaussian-family.puml

This file was deleted.

31 changes: 0 additions & 31 deletions docs/diagrams/likelihood.puml

This file was deleted.

5 changes: 0 additions & 5 deletions docs/diagrams/likelihood_frag.iuml

This file was deleted.

41 changes: 0 additions & 41 deletions docs/diagrams/sacc_data.puml

This file was deleted.

6 changes: 0 additions & 6 deletions docs/diagrams/skinparams.iuml

This file was deleted.

9 changes: 0 additions & 9 deletions docs/diagrams/statistic.puml

This file was deleted.

5 changes: 0 additions & 5 deletions docs/diagrams/statistic_frag.iuml

This file was deleted.

34 changes: 0 additions & 34 deletions docs/diagrams/twopoint.puml

This file was deleted.

15 changes: 0 additions & 15 deletions docs/diagrams/typedefs.puml

This file was deleted.

53 changes: 0 additions & 53 deletions docs/diagrams/updatable.puml

This file was deleted.

Loading
Loading