Skip to content

Commit a1d92be

Browse files
authored
Added the docstrings to the shim class (#66)
* Added the docstrings to the shim class * Docstrings are recognised by sphinx now * Sphinx documentation has a basic structure now * added logo in readme * Cleaned up the C++ code
1 parent 48f9686 commit a1d92be

10 files changed

+1101
-842
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# fastjet
1+
<img src="docs/logo.svg">
22

33
[![Actions Status][actions-badge]][actions-link]
44
[![Documentation Status][rtd-badge]][rtd-link]

docs/AwkwardClusterSequence.rst

-13
This file was deleted.

docs/clustersequence.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
fastjet.ClusterSequence
2+
===============
3+
.. autoclass:: fastjet.ClusterSequence
4+
:members:

docs/index.rst

+27-7
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,48 @@
1+
.. |br| raw:: html
12

2-
**Welcome to documentation!**
3-
=============================
3+
<br/>
44

5+
.. role:: raw-html(raw)
6+
:format: html
57

6-
Introduction
7-
------------
8+
9+
.. image:: logo.svg
10+
:width: 300px
11+
:alt: fastjet
12+
:target: https://github.com/scikit-hep/fastjet
813

914
Fastjet is a library for perfomring Jet-Finding *within* the Scikit-HEP ecosystem.
15+
The library includes the classic interface, and a new interface built to perform clustering on multi-event Awkward Array objects.
1016

1117
.. note::
1218
This project is under active development.
1319

20+
Documentation
21+
---------------
22+
23+
* Python interface - This site.
24+
* `GitHub <https://github.com/scikit-hep/fastjet/>`_
25+
26+
Installation
27+
-------------
28+
29+
fastjet can be installed from `pypi <https://pypi.org/project/fastjet/>`_ using pip: ::
30+
31+
pip install fastjet
32+
33+
Most users will get a precompiled binary (wheel) for your operating system and Python version. If not, the above attempts to compile from source.
1434

1535
.. toctree::
1636
:maxdepth: 2
1737
:titlesonly:
1838
:caption: Contents
1939
:glob:
2040

21-
AwkwardClusterSequence
41+
pseudojet
42+
jetdefinition
43+
clustersequence
2244

2345

24-
.. autoclass:: fastjet.ClusterSequence
25-
:members:
2646

2747
Indices and tables
2848
==================

docs/jetdefinition.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
fastjet.JetDefinition
2+
======================
3+
.. autoclass:: fastjet.JetDefinition
4+
:members:

docs/logo.svg

+713
Loading

docs/pseudojet.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
fastjet.PseudoJet
2+
==================
3+
4+
.. autoclass:: fastjet.PseudoJet
5+
:members:

src/_ext.cpp

+25-608
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)