Skip to content

Commit

Permalink
Update doxygen, add Github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dmalhotra committed Aug 3, 2023
1 parent 1c7af14 commit 7a6bb6e
Show file tree
Hide file tree
Showing 22 changed files with 880 additions and 1,069 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/ghpages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: GitHub Pages

on:
push:
branches:
- master # Set a branch to deploy
pull_request:

jobs:
deploy:
runs-on: ubuntu-22.04
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v3
with:
submodules: true
fetch-depth: 0


- name: 'Get Previous tag'
id: previoustag
uses: "WyriHaximus/github-action-get-previous-tag@v1"
with:
fallback: 1.0.0

- name: Set env
run: echo "VERSION=${{ steps.previoustag.outputs.tag }}" >> $GITHUB_ENV

- name: Doxygen Action
uses: mattnotmitt/[email protected]
with:
doxyfile-path: ./Doxyfile
working-directory: .

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/master'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html

Empty file removed ChangeLog
Empty file.
1,003 changes: 682 additions & 321 deletions Doxyfile

Large diffs are not rendered by default.

13 changes: 4 additions & 9 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ RESULT_DIR = ./result
# the subdirectories of the project to go into
#SUBDIRS =

DIST_SUBDIRS= \
doc/doc
#DIST_SUBDIRS = doc/doc


EXTRA_DIST = \
$(EX_DIR)/src \
Expand All @@ -26,7 +26,7 @@ EXTRA_DIST = \
$(DX_CONFIG) \
scripts

# additional include pathes necessary to compile the C++ library
# additional include paths necessary to compile the C++ library
AM_CXXFLAGS =
#AM_LDFLAGS = -static

Expand Down Expand Up @@ -210,10 +210,7 @@ $(EX_DIR)/bin/%: core
# BUILD DOCUMENTATION
#------------------------------------------------------------------------------

pdf-doc:
cd doc/doc && $(MAKE);

all-docs: doxygen-doc pdf-doc
all-docs: doxygen-doc

###############################################################################
# INSTALL/UNINSTALL MakeVariables, pvfmm_config.h
Expand Down Expand Up @@ -282,10 +279,8 @@ install: install-am
@echo '======================================================================='

install-data-local: install-make-variables install-libtool install-doxygen-doc
cd doc/doc && $(MAKE) install;

uninstall-local: uninstall-make-variables uninstall-libtool uninstall-doxygen-doc
cd doc/doc && $(MAKE) uninstall;


###############################################################################
Expand Down
Empty file removed NEWS
Empty file.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# PVFMM [![Build Status](https://github.com/dmalhotra/pvfmm/actions/workflows/build.yml/badge.svg)](https://github.com/dmalhotra/pvfmm/actions/workflows/build.yml)
[![Stable Version](https://badgen.net/github/tag/dmalhotra/pvfmm)](https://github.com/dmalhotra/pvfmm/tags)
[![Latest Release](https://img.shields.io/github/v/release/dmalhotra/pvfmm?color=%233D9970)](https://github.com/dmalhotra/pvfmm/releases)
# PVFMM [![Build Status](https://github.com/dmalhotra/pvfmm/actions/workflows/build.yml/badge.svg)](https://github.com/dmalhotra/pvfmm/actions/workflows/build.yml) [![Stable Version](https://badgen.net/github/tag/dmalhotra/pvfmm)](https://github.com/dmalhotra/pvfmm/tags) [![Latest Release](https://img.shields.io/github/v/release/dmalhotra/pvfmm?color=%233D9970)](https://github.com/dmalhotra/pvfmm/releases)


### What is PVFMM?
Expand All @@ -22,12 +20,12 @@
### License

PVFMM is distributed under the LGPLv3 licence. See COPYING in
the top-level directory of the distribution.
the top-level directory of the distribution.

### Installing PVFMM

To install PVFMM, follow the steps in the INSTALL file, which is
located in the top directory of the source distribution.
located in the top directory of the source distribution.


### Using PVFMM
Expand All @@ -39,7 +37,7 @@

Two very simple examples illustrating usage of the library are available:
For particle N-body : examples/src/example1.cpp
For volume potentials: examples/src/example2.cpp
For volume potentials: examples/src/example2.cpp

To compile these examples:
make examples/bin/example1
Expand Down
23 changes: 0 additions & 23 deletions TODO

This file was deleted.

5 changes: 2 additions & 3 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -221,10 +221,9 @@ AC_ARG_WITH(precomp-dir,
[PRECOMP_DIR="$withval"; AX_NORMALIZE_PATH([PRECOMP_DIR], ["/"]) ])
AC_DEFINE_UNQUOTED(PRECOMP_DATA_PATH,"$PRECOMP_DIR",[Path for precomputed data files.])

#AC_CONFIG_FILES([Makefile doc/doc/Makefile])
#AC_CONFIG_FILES([Makefile])
AC_CONFIG_FILES([Makefile
MakeVariables
doc/doc/Makefile])
MakeVariables])
AC_OUTPUT

echo "
Expand Down
11 changes: 0 additions & 11 deletions doc/.gitignore

This file was deleted.

63 changes: 0 additions & 63 deletions doc/doc/Makefile.am

This file was deleted.

30 changes: 0 additions & 30 deletions doc/doc/bibsync.bib

This file was deleted.

Loading

0 comments on commit 7a6bb6e

Please sign in to comment.