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.

Sign up for GitHub

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

Jump to bottom

Updating documentation to V2R5M3 #112

Merged
merged 11 commits into from
Apr 21, 2024
Merged

Updating documentation to V2R5M3 #112

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
319a265
updating gitignore to include docs/.venv/
mainframed Apr 16, 2024
ad573c2
Updating documentation to V2R5M3
mainframed Apr 17, 2024
b17ada6
Updating some typos in array.rst and changing the PDF theme for a cle…
mainframed Apr 17, 2024
c4b2ea6
Updating HTML documentation with V2R5M3 updates
mainframed Apr 17, 2024
0f68cd4
adding rxlib and samples folders
mainframed Apr 19, 2024
1920c8e
moving folders from mvs/install to root folder as well as adding new …
mainframed Apr 19, 2024
751f947
moving proclib out of mvs/install to root folder and updating proclib…
mainframed Apr 19, 2024
b7e0bb3
updating and moving the jcl folder from mvs/install to the root folder
mainframed Apr 19, 2024
983febb
adding readme that explains the purpose of the folders
mainframed Apr 19, 2024
08c4369
renaming the files to CLIST instead of REXX and adding a README
mainframed Apr 19, 2024
e60d1ca
renaming the files from rexx to jcl and adding a readme
mainframed Apr 19, 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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ build/*.log
build/*.out
build/*.jcl
docs/build/
docs/.venv/
.DS_Store
4 changes: 2 additions & 2 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
RINOHBUILD = build/rinoh
PDFBUILD = build/pdf

# Put it first so that "make" without argument is like "make help".
help:
Expand All @@ -16,7 +16,7 @@ help:
.PHONY: help Makefile

pdf:
@$(SPHINXBUILD) -b rinoh "$(SOURCEDIR)" "$(RINOHBUILD)"
@$(SPHINXBUILD) -b pdf "$(SOURCEDIR)" "$(PDFBUILD)"

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
16 changes: 10 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ contains all documentation for BREXX/370.
## Requirements

To build the documentation you need the make command, python 3, Sphinx,
the Sphinx Read the Docs theme, pip, and rinohtype. Once make and
the Sphinx Read the Docs theme, pip, and rst2pdf. Once make and
python 3 and pip are installed you can install the remaining
requirements with:

```
pip install sphinx
pip install sphinx_rtd_theme
pip install rinohtype
pip install rst2pdf
```

## Generate HTML documentation
Expand All @@ -22,15 +22,19 @@ To generate the HTML documentation use the command `make html` in this
folder. This will generate html based documentation in
`buid/html/`. Opening `index.html` in that folder will open the
documentation. This has already been done and the newly generated
documentation placed in `docs/`.
documentation placed in `doc/`.

## Generate PDF documentation

To generate the PDF documentation use the command `make pdf`. This uses
rinohtype and the style/template `brexx.rts`/`brexx.rtt` to generate
rst2pdf and the styles/templates `cover.tmpl`, `cover.yaml` and `style.yaml` to generate
the PDF file. The generated PDF file will be located in
`build/rinoh/BREXX370_Users_Guide.pdf`
`build/pdf/BREXX370_Users_Guide.pdf`

### Sphinx Warnings

Sphinx warns about duplicate entries. These can safely be ignored.
Sphinx warns about duplicate entries. These can safely be ignored.

### rst2pdf Warnings

rst2pdf warns about duplicate entries and text beeing too wide. These can safely be ignored.
Loading
Loading