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

Doxygen->Breathe->Sphinx MLL docs #6

Merged
merged 55 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
084eb48
Doxygne->breathe->Sphinx for MLL docs
brtnfld Oct 31, 2024
7fd6fcb
Doxygen config file
brtnfld Oct 31, 2024
5e6af24
install doxygen
brtnfld Oct 31, 2024
4351d3e
install doxygen
brtnfld Oct 31, 2024
bb1883b
install doxygen
brtnfld Oct 31, 2024
66c0e02
install doxygen
brtnfld Oct 31, 2024
303fc62
updates to Breathe
brtnfld Oct 31, 2024
63c84e8
Sphinx updates
brtnfld Oct 31, 2024
dd0a84f
fixed broken links
brtnfld Oct 31, 2024
c9f37f3
format fixes
brtnfld Oct 31, 2024
fc80e8b
added userguide troubleshooting
brtnfld Oct 31, 2024
ca47eec
fixed broken links
brtnfld Oct 31, 2024
25bc6df
added makefile builds for Sphinx
brtnfld Oct 31, 2024
fbd6a92
fixed sids issue
brtnfld Oct 31, 2024
080e96c
added particle information
brtnfld Nov 21, 2024
a7f3e4c
create missing dir
brtnfld Nov 21, 2024
56cc633
added particle specs
brtnfld Nov 26, 2024
cf9f4d9
updated Doxygen config file
brtnfld Nov 26, 2024
c327558
added particle info
brtnfld Nov 26, 2024
b8a1d3b
install sphinx-book-theme
brtnfld Nov 26, 2024
723be7f
removed site map on landing page, minor updates
brtnfld Nov 27, 2024
a2ebcb5
restore menu
brtnfld Nov 27, 2024
73841ad
updated sids references
brtnfld Nov 27, 2024
efb82a0
Merge remote-tracking branch 'upstream/doc-rest-migration' into doc-r…
brtnfld Nov 28, 2024
5a1c0a9
fixed links and various updates
brtnfld Nov 29, 2024
b75a7d5
added broken link checker
brtnfld Nov 29, 2024
9bfe237
fixed enum links
brtnfld Dec 2, 2024
1f04348
updated TODO links
brtnfld Dec 3, 2024
5ae70ba
updated generating documentation
brtnfld Dec 3, 2024
1c3c530
sp.
brtnfld Dec 3, 2024
472ac81
removed invalid email contacts
brtnfld Dec 3, 2024
0a96e4d
removed Chris' email
brtnfld Dec 3, 2024
488895f
sp.
brtnfld Dec 3, 2024
eb6eaf4
adding missing information
brtnfld Dec 5, 2024
2883af4
updated minutes
brtnfld Dec 12, 2024
2109f65
updated the download section
brtnfld Dec 12, 2024
383ee1f
sp
brtnfld Dec 12, 2024
471587d
Updated download.rst
brtnfld Dec 12, 2024
558821a
Update CGNS_MLL.rst
brtnfld Dec 12, 2024
4cf1a78
Update userguide_troubleshooting.rst
brtnfld Dec 12, 2024
c6b2835
Update userguide.rst
brtnfld Dec 12, 2024
3f1d67f
Update general_remarks.rst
brtnfld Dec 12, 2024
e2cc35c
Update hdf5.rst
brtnfld Dec 12, 2024
ee75230
Update python.rst
brtnfld Dec 12, 2024
1e8374d
Update index.rst
brtnfld Dec 12, 2024
2d6d07a
rst formatting clean-up
brtnfld Dec 12, 2024
d0bdf9d
sp
brtnfld Dec 12, 2024
8c3a978
formatting updates
brtnfld Dec 13, 2024
c00aa6b
updated links and formatting
brtnfld Dec 14, 2024
f9c20ba
updates,sp
brtnfld Dec 14, 2024
834c4a3
updated members
brtnfld Dec 14, 2024
15a2783
Update overview.rst
brtnfld Dec 15, 2024
4e6cc43
removed references to cgnstalk mailing list
brtnfld Dec 15, 2024
ac38568
change build directory
brtnfld Dec 16, 2024
bfd25d1
documentation updates
brtnfld Dec 16, 2024
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
29 changes: 20 additions & 9 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ jobs:
runs-on: ubuntu-latest

steps:
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install doxygen

- name: "Checkout"
uses: actions/[email protected]
Expand All @@ -25,24 +29,31 @@ jobs:
- name: "Install python dependencies"
run: |
pip3 install setuptools six
pip3 install sphinx sphinx-rtd-theme
pip3 install guzzle_sphinx_theme
pip3 install sphinx-fortran
# pip3 install sphinx-mathjax-offline
pip3 install sphinx_sitemap
pip3 install numpy
pip3 install breathe
pip3 install sphinx-book-theme
pip3 install linkchecker

- name: "Build sphinx doc"
run: |
cd CGNS-ReST-site
chmod +x build.sh
./build.sh
make html
shell: bash


- name: "Check for broken links"
run: |
cd CGNS-ReST-site/docs/html/
linkchecker --check-extern ./index.html
continue-on-error: true

- name: "Deploy"
run: |
cd CGNS-ReST-site
git clone -b gh-pages --single-branch https://github.com/CGNS/cgns-modern.github.io.git docs/_build/deploy
rsync -q -av --checksum --progress docs/_build/html/ docs/_build/deploy
cd docs/_build/deploy
git clone -b gh-pages --single-branch https://github.com/CGNS/cgns-modern.github.io.git docs/deploy
rsync -q -av --checksum --progress docs/html/ docs/deploy
cd docs/deploy
git config --global user.name 'autopages'
git config --global user.email '[email protected]'
git add --all .
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "CGNS"]
path = CGNS
url = https://github.com/CGNS/CGNS.git
1 change: 1 addition & 0 deletions CGNS
Submodule CGNS added at e43d86
2,988 changes: 2,988 additions & 0 deletions CGNS-ReST-site/Doxyfile

Large diffs are not rendered by default.

26 changes: 26 additions & 0 deletions CGNS-ReST-site/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = ./docs/html
CURRENT_DIR = $(shell pwd)

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
git submodule update --remote --merge
if [ ! -d $(BUILDDIR) ]; then mkdir -p $(BUILDDIR); fi
cp -r ./images "$(BUILDDIR)"
@$(SPHINXBUILD) -E -n -c . -b html source "$(BUILDDIR)" $(SPHINXOPTS) $(O)

#@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
69 changes: 69 additions & 0 deletions CGNS-ReST-site/_static/CGNS_logo_nobckgrnd.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added CGNS-ReST-site/_static/cgns.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions CGNS-ReST-site/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/*Disables Dark Mode*/
button.theme-switch-button {
display: none !important;
}
/*
html[data-theme="light"] {
--pst-color-link: #56bb92;
--pst-color-text-base: #2f3645;
}
*/
5 changes: 5 additions & 0 deletions CGNS-ReST-site/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
# this is doc generation for a UNIX host
# generation is made in a separate directory, change its path here:

CURRENT_DIR=$PWD
cd ..
git submodule update --remote --merge
cd $CURRENT_DIR

export build_dir=./docs/_build/html

cp -r ./images ${build_dir}/
Expand Down
Loading
Loading