%global _empty_manifest_terminate_build 0 Name: python-inspect-it Version: 0.3.2 Release: 1 Summary: Reads your code and returns a JSON description you can use to generate documentation. Like Sphinx AutoDoc but without Sphinx. License: ISC URL: UNKNOWN Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f8/02/eabdd15262ab4588eb9cf97201628bf7d218c90541a98c450ddcead76781/inspect-it-0.3.2.tar.gz BuildArch: noarch %description Inspect. When documenting a library or software product written in Python, often a README is not enough, but full-blown Sphinx is too much work or too rigid. Inspect is a command-line tool that will automatically document Python code, but it returns the output as machine-readable JSON or human-readable Markdown, so you retain full control of how to render the documentation. Usage: inspect [] [options] Options: -m --markdown At what level to start headers. --include ... --exclude ... If you only need a single object documented (whether a function, a class or something else), you can use the .. raw:: html argument: :: # will only include documentation on `A` inspect fixtures/example.py A Filtering the output with ``--include`` and ``--exclude`` ensures that your code description only contains exactly what you want it to. Some examples: :: # only include class methods if they've been documented inspect fixtures/example.py --include members.documented # only include classes inspect fixtures/example.py --include type:class # only document function `factorize` and class `Bean` inspect fixtures/example.py --include name:fun,name:B # only include documented methods on Bean # (these two are identical) inspect fixtures/example.py Bean --include documented inspect fixtures/example.py --include name:Bean,members.documented As you can see, ``.`` traverses the hierarchy and ``:`` is the value to test against. (If you don't specify a value, we will test on presence.) ``,`` separates multiple criteria that are OR'ed together. Todo: - improve documentation - unit test the filtering mechanism - fill out missing information in the description JSON (if any) - an ``intercalate`` utility that runs shell commands inside of ``%%`` tags in a file and replaces the tags with the standard output from those commands %package -n python3-inspect-it Summary: Reads your code and returns a JSON description you can use to generate documentation. Like Sphinx AutoDoc but without Sphinx. Provides: python-inspect-it BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-inspect-it Inspect. When documenting a library or software product written in Python, often a README is not enough, but full-blown Sphinx is too much work or too rigid. Inspect is a command-line tool that will automatically document Python code, but it returns the output as machine-readable JSON or human-readable Markdown, so you retain full control of how to render the documentation. Usage: inspect [] [options] Options: -m --markdown At what level to start headers. --include ... --exclude ... If you only need a single object documented (whether a function, a class or something else), you can use the .. raw:: html argument: :: # will only include documentation on `A` inspect fixtures/example.py A Filtering the output with ``--include`` and ``--exclude`` ensures that your code description only contains exactly what you want it to. Some examples: :: # only include class methods if they've been documented inspect fixtures/example.py --include members.documented # only include classes inspect fixtures/example.py --include type:class # only document function `factorize` and class `Bean` inspect fixtures/example.py --include name:fun,name:B # only include documented methods on Bean # (these two are identical) inspect fixtures/example.py Bean --include documented inspect fixtures/example.py --include name:Bean,members.documented As you can see, ``.`` traverses the hierarchy and ``:`` is the value to test against. (If you don't specify a value, we will test on presence.) ``,`` separates multiple criteria that are OR'ed together. Todo: - improve documentation - unit test the filtering mechanism - fill out missing information in the description JSON (if any) - an ``intercalate`` utility that runs shell commands inside of ``%%`` tags in a file and replaces the tags with the standard output from those commands %package help Summary: Development documents and examples for inspect-it Provides: python3-inspect-it-doc %description help Inspect. When documenting a library or software product written in Python, often a README is not enough, but full-blown Sphinx is too much work or too rigid. Inspect is a command-line tool that will automatically document Python code, but it returns the output as machine-readable JSON or human-readable Markdown, so you retain full control of how to render the documentation. Usage: inspect [] [options] Options: -m --markdown At what level to start headers. --include ... --exclude ... If you only need a single object documented (whether a function, a class or something else), you can use the .. raw:: html argument: :: # will only include documentation on `A` inspect fixtures/example.py A Filtering the output with ``--include`` and ``--exclude`` ensures that your code description only contains exactly what you want it to. Some examples: :: # only include class methods if they've been documented inspect fixtures/example.py --include members.documented # only include classes inspect fixtures/example.py --include type:class # only document function `factorize` and class `Bean` inspect fixtures/example.py --include name:fun,name:B # only include documented methods on Bean # (these two are identical) inspect fixtures/example.py Bean --include documented inspect fixtures/example.py --include name:Bean,members.documented As you can see, ``.`` traverses the hierarchy and ``:`` is the value to test against. (If you don't specify a value, we will test on presence.) ``,`` separates multiple criteria that are OR'ed together. Todo: - improve documentation - unit test the filtering mechanism - fill out missing information in the description JSON (if any) - an ``intercalate`` utility that runs shell commands inside of ``%%`` tags in a file and replaces the tags with the standard output from those commands %prep %autosetup -n inspect-it-0.3.2 %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-inspect-it -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Fri May 05 2023 Python_Bot - 0.3.2-1 - Package Spec generated