Question

我刚刚开始使用Sphinx（sphinx-doc.org）来记录Python项目。到目前为止，它可以正常工作，并且我可以对我的Python代码进行doc和自动doc。

该项目还包含几个bash脚本。我也想使用autodoc来记录那些bash脚本。我找不到bash脚本的特定域。所以我想一个人必须使用标准域？

您将如何执行此操作（如果可能）？如何在bash脚本中配置index.rst以及如何使用reStructuredText？

Answer 1

这是您要求的示例。我在source_suffix中使用.rst，但是您可以在conf.py中为您的网站进行更改。注意，我将bash文件命名为test.sh.rst，以提醒自己它是bash文件。只要您使用chmod +x设置mod，Linux都不关心文件名是什么。

index.rst示例：

.. _MyManual:

My Manual
===========================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   doc/doc
   bash/test.sh

示例test.sh.rst：

#!/bin/bash
: '

***********************
Example Bash
***********************

Using multi-line comment for larger comments. 

And use hash # to proceed code so it shows nicely in sphinx. Note the double 
:: at the end to give the proper formatting. 

'

# Initial code::

    mkdir tmp

# check_client::

   check_client()
   {
   # determine if this is being run on a client that is using git folder
   # check the parameter for the bash on CLI and if exist, use it
   echo HERE in client "$1" and "$parameter_1"
   if [[ "$parameter_1" = "" ]]; then
      client_directory=/
   else
      client_directory=/git
   fi
   }

# other code::

   parameter_1="$1"
   check_client
   echo the client is "$client_directory"

   read -p "pause " answer

如何使用Sphinx记录bash脚本？

1 个答案: