diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-05 12:10:11 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-05 12:10:11 +0000 |
| commit | d2783dff359f52f72d56f11dc71b1f6ab5a1f484 (patch) | |
| tree | 95ba1540e45b17398c0862c3b681c1c00ef92eb1 | |
| parent | e94f6425bacc21360b7fe9828783a33d18483f4c (diff) | |
automatic import of python-fordopeneuler20.03
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-ford.spec | 377 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 379 insertions, 0 deletions
@@ -0,0 +1 @@ +/FORD-6.2.4.tar.gz diff --git a/python-ford.spec b/python-ford.spec new file mode 100644 index 0000000..c2968f9 --- /dev/null +++ b/python-ford.spec @@ -0,0 +1,377 @@ +%global _empty_manifest_terminate_build 0 +Name: python-FORD +Version: 6.2.4 +Release: 1 +Summary: FORD (FORtran Documenter) is an automatic documentation generator for modern Fortran programs. +License: GPLv3 +URL: https://pypi.org/project/FORD/ +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/13/79/27370ac87ff984684d5b51747aeb62583a4ad9fbd90c7d93867961655aa5/FORD-6.2.4.tar.gz +BuildArch: noarch + +Requires: python3-markdown +Requires: python3-markdown-include +Requires: python3-markdown-math +Requires: python3-toposort +Requires: python3-jinja2 +Requires: python3-pygments +Requires: python3-beautifulsoup4 +Requires: python3-graphviz +Requires: python3-tqdm +Requires: python3-sphinx +Requires: python3-sphinx-autodoc-typehints +Requires: python3-sphinx-book-theme +Requires: python3-sphinx-argparse-cli +Requires: python3-pytest + +%description +# FORD +[](https://pypi.python.org/pypi/FORD) +[](http://braumeister.org/formula/ford) +[](https://spack.readthedocs.io/en/latest/package_list.html#py-ford) +[](https://pepy.tech/project/ford) +[](./LICENSE) +[](https://doi.org/10.5281/zenodo.1422473) + +This is an automatic documentation generator for modern Fortran programs. +FORD stands for FORtran Documenter. As you may know, "to ford" refers to +crossing a river (or other body of water). It does not, in this context, refer +to any company or individual associated with cars. + +Ford was written due to [Doxygen](http://www.doxygen.org/)'s +poor handling of Fortran and the lack of comparable alternatives. +[ROBODoc](https://rfsber.home.xs4all.nl/Robo/index.html) can't actually extract +any information from the source code and just about any other automatic +documentation software I found was either proprietary, didn't work very well +for Fortran, or was limited in terms of how it produced its output. +[f90doc](http://erikdemaine.org/software/f90doc/) is quite good and I managed +to modify it so that it could handle most of Fortran 2003, but it produces +rather ugly documentation, can't provide as many links between different parts +of the documentation as I'd like, and is written in Perl (which I'm not that +familiar with and which lacks the sort of libraries found in Python for +producing HTML content). + +The goal of FORD is to be able to reliably produce documentation for modern +Fortran software which is informative and nice to look at. The documentation +should be easy to write and non-obtrusive within the code. While it will never +be as feature-rich as Doxygen, hopefully FORD will be able to provide a good +alternative for documenting Fortran projects. + +## Capabilities +Current features include: + +- the ability to extract information about variables, procedures, procedure + arguments, derived types, programs, and modules from the source code. +- the ability to extract documentation from comments in the source code. +- LaTeX support in documentation using [MathJax](https://www.mathjax.org/). +- searchable documentation, using [Tipue Search](http://www.tipue.com/search/). +- author description and social media (including Github!) links. +- links to download the source code. +- links to individual files, both in their raw form or in HTML with syntax + highlighting. +- use of Markdown to type-set documentation. +- links between related parts of the software. +- Bootstrap CSS for the documentation, making it both functional and pretty. +- configurable settings. +- ability to create a hierarchical set of pages containing general information, + not associated with any particular part of the source code. +- display an entry for non-Fortran source files with file-level documentation + and syntax highlighted code. + +## Installation + +The simplest way to install FORD is using [pip](https://pip.pypa.io/en/latest/): + + pip install ford + +Pip will automatically handle all dependencies for you. By default this will +place `ford` in `~/.local/bin` -- you might need to add this to your `PATH`. + +Alternatively, FORD is available through the [Homebrew](https://brew.sh) package +manager for Mac OS X. To update Homebrew and install FORD, run these commands in +a terminal: + + brew update + brew install FORD + +If you would like to install the latest development (master) branch from github, +simply add the `--HEAD` flag: `brew install --HEAD FORD` + +FORD is also available through the +[spack](https://spack.readthedocs.io/en/latest/) package manager by running the +following command: + + spack install py-ford + +## Documentation +More complete documentation can be found in the [docs](https://forddocs.readthedocs.io). + +## License +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but **without any warrenty**; without even the implied warranty of +**merchantability** or **fitness for a particular purpose**. See the +GNU General Public License for more details. + +You should have received a [copy](./LICENSE) of the GNU General Public License +along with this program. If not, see the [GNU website](https://www.gnu.org/licenses/gpl.html). + +Documents produced by FORD are derivative works derived from the input used in their production; +they are not affected by this license. + + +%package -n python3-FORD +Summary: FORD (FORtran Documenter) is an automatic documentation generator for modern Fortran programs. +Provides: python-FORD +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-FORD +# FORD +[](https://pypi.python.org/pypi/FORD) +[](http://braumeister.org/formula/ford) +[](https://spack.readthedocs.io/en/latest/package_list.html#py-ford) +[](https://pepy.tech/project/ford) +[](./LICENSE) +[](https://doi.org/10.5281/zenodo.1422473) + +This is an automatic documentation generator for modern Fortran programs. +FORD stands for FORtran Documenter. As you may know, "to ford" refers to +crossing a river (or other body of water). It does not, in this context, refer +to any company or individual associated with cars. + +Ford was written due to [Doxygen](http://www.doxygen.org/)'s +poor handling of Fortran and the lack of comparable alternatives. +[ROBODoc](https://rfsber.home.xs4all.nl/Robo/index.html) can't actually extract +any information from the source code and just about any other automatic +documentation software I found was either proprietary, didn't work very well +for Fortran, or was limited in terms of how it produced its output. +[f90doc](http://erikdemaine.org/software/f90doc/) is quite good and I managed +to modify it so that it could handle most of Fortran 2003, but it produces +rather ugly documentation, can't provide as many links between different parts +of the documentation as I'd like, and is written in Perl (which I'm not that +familiar with and which lacks the sort of libraries found in Python for +producing HTML content). + +The goal of FORD is to be able to reliably produce documentation for modern +Fortran software which is informative and nice to look at. The documentation +should be easy to write and non-obtrusive within the code. While it will never +be as feature-rich as Doxygen, hopefully FORD will be able to provide a good +alternative for documenting Fortran projects. + +## Capabilities +Current features include: + +- the ability to extract information about variables, procedures, procedure + arguments, derived types, programs, and modules from the source code. +- the ability to extract documentation from comments in the source code. +- LaTeX support in documentation using [MathJax](https://www.mathjax.org/). +- searchable documentation, using [Tipue Search](http://www.tipue.com/search/). +- author description and social media (including Github!) links. +- links to download the source code. +- links to individual files, both in their raw form or in HTML with syntax + highlighting. +- use of Markdown to type-set documentation. +- links between related parts of the software. +- Bootstrap CSS for the documentation, making it both functional and pretty. +- configurable settings. +- ability to create a hierarchical set of pages containing general information, + not associated with any particular part of the source code. +- display an entry for non-Fortran source files with file-level documentation + and syntax highlighted code. + +## Installation + +The simplest way to install FORD is using [pip](https://pip.pypa.io/en/latest/): + + pip install ford + +Pip will automatically handle all dependencies for you. By default this will +place `ford` in `~/.local/bin` -- you might need to add this to your `PATH`. + +Alternatively, FORD is available through the [Homebrew](https://brew.sh) package +manager for Mac OS X. To update Homebrew and install FORD, run these commands in +a terminal: + + brew update + brew install FORD + +If you would like to install the latest development (master) branch from github, +simply add the `--HEAD` flag: `brew install --HEAD FORD` + +FORD is also available through the +[spack](https://spack.readthedocs.io/en/latest/) package manager by running the +following command: + + spack install py-ford + +## Documentation +More complete documentation can be found in the [docs](https://forddocs.readthedocs.io). + +## License +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but **without any warrenty**; without even the implied warranty of +**merchantability** or **fitness for a particular purpose**. See the +GNU General Public License for more details. + +You should have received a [copy](./LICENSE) of the GNU General Public License +along with this program. If not, see the [GNU website](https://www.gnu.org/licenses/gpl.html). + +Documents produced by FORD are derivative works derived from the input used in their production; +they are not affected by this license. + + +%package help +Summary: Development documents and examples for FORD +Provides: python3-FORD-doc +%description help +# FORD +[](https://pypi.python.org/pypi/FORD) +[](http://braumeister.org/formula/ford) +[](https://spack.readthedocs.io/en/latest/package_list.html#py-ford) +[](https://pepy.tech/project/ford) +[](./LICENSE) +[](https://doi.org/10.5281/zenodo.1422473) + +This is an automatic documentation generator for modern Fortran programs. +FORD stands for FORtran Documenter. As you may know, "to ford" refers to +crossing a river (or other body of water). It does not, in this context, refer +to any company or individual associated with cars. + +Ford was written due to [Doxygen](http://www.doxygen.org/)'s +poor handling of Fortran and the lack of comparable alternatives. +[ROBODoc](https://rfsber.home.xs4all.nl/Robo/index.html) can't actually extract +any information from the source code and just about any other automatic +documentation software I found was either proprietary, didn't work very well +for Fortran, or was limited in terms of how it produced its output. +[f90doc](http://erikdemaine.org/software/f90doc/) is quite good and I managed +to modify it so that it could handle most of Fortran 2003, but it produces +rather ugly documentation, can't provide as many links between different parts +of the documentation as I'd like, and is written in Perl (which I'm not that +familiar with and which lacks the sort of libraries found in Python for +producing HTML content). + +The goal of FORD is to be able to reliably produce documentation for modern +Fortran software which is informative and nice to look at. The documentation +should be easy to write and non-obtrusive within the code. While it will never +be as feature-rich as Doxygen, hopefully FORD will be able to provide a good +alternative for documenting Fortran projects. + +## Capabilities +Current features include: + +- the ability to extract information about variables, procedures, procedure + arguments, derived types, programs, and modules from the source code. +- the ability to extract documentation from comments in the source code. +- LaTeX support in documentation using [MathJax](https://www.mathjax.org/). +- searchable documentation, using [Tipue Search](http://www.tipue.com/search/). +- author description and social media (including Github!) links. +- links to download the source code. +- links to individual files, both in their raw form or in HTML with syntax + highlighting. +- use of Markdown to type-set documentation. +- links between related parts of the software. +- Bootstrap CSS for the documentation, making it both functional and pretty. +- configurable settings. +- ability to create a hierarchical set of pages containing general information, + not associated with any particular part of the source code. +- display an entry for non-Fortran source files with file-level documentation + and syntax highlighted code. + +## Installation + +The simplest way to install FORD is using [pip](https://pip.pypa.io/en/latest/): + + pip install ford + +Pip will automatically handle all dependencies for you. By default this will +place `ford` in `~/.local/bin` -- you might need to add this to your `PATH`. + +Alternatively, FORD is available through the [Homebrew](https://brew.sh) package +manager for Mac OS X. To update Homebrew and install FORD, run these commands in +a terminal: + + brew update + brew install FORD + +If you would like to install the latest development (master) branch from github, +simply add the `--HEAD` flag: `brew install --HEAD FORD` + +FORD is also available through the +[spack](https://spack.readthedocs.io/en/latest/) package manager by running the +following command: + + spack install py-ford + +## Documentation +More complete documentation can be found in the [docs](https://forddocs.readthedocs.io). + +## License +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but **without any warrenty**; without even the implied warranty of +**merchantability** or **fitness for a particular purpose**. See the +GNU General Public License for more details. + +You should have received a [copy](./LICENSE) of the GNU General Public License +along with this program. If not, see the [GNU website](https://www.gnu.org/licenses/gpl.html). + +Documents produced by FORD are derivative works derived from the input used in their production; +they are not affected by this license. + + +%prep +%autosetup -n FORD-6.2.4 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-FORD -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 6.2.4-1 +- Package Spec generated @@ -0,0 +1 @@ +d9fb06f9d3b1ef7b56ca303001f94f2f FORD-6.2.4.tar.gz |