-
Docstrings need to either be added or put into proper format
-
Is there a way to use Sphinx to build documentation that would list the Function/Methods, their parameters, and expected returns? Using `pydoc` doesn't seem to format the docstrings properly.
Also…
-
Hi,
Have you tried working with sphinx?
I totally missed this part during the classes
-
The source code is documented ether via doxygen-like comments (this holds true for the c++ code) or via python docstrings. It might (!) be a good idea to include this documentation in an automatic fas…
-
**Describe the bug**
I'm trying to convert a project from Doxygen to Doxygen/Breathe/Sphinx and cannot get past an exception being thrown on invocation of `sphinx-build`:
> AttributeError: 'str' o…
-
This would be a further enhancement for #21 I guess: currently sphinx-js hooks on `builder-inited` to parse the JS, but that means it runs jsdoc on the source tree on every build period. This doesn't …
-
I just installed mudkip and opened an empty index.rst - but so impressed by ease of use `mudkip`. Thank you for developing it!
My initial reaction is to suggest adding https://github.com/executable…
-
[I am maintaining some Python API documentation for Ethereum and Web3.py ecosystem](https://smart-contracts-for-testing.readthedocs.io/).
To improve the readability of the API documentation, I stum…
-
I wrote all my Docstrings, and I tried to use the Sphinx Quickstart tool in Pycharm to generate documentation. I think I followed the procedure on how to generate documentation but it's not working, a…
HL232 updated
5 years ago
-
# 目的
`PyPI` にテストでパッケージ公開を行う
# 提案内容
- `__init__.py` : パッケージ基本情報を記述
- `setup.py` : パッケージ作成情報を記述
- `MANIFEST.in` : 配布物に追加、または除外するファイルを記述
まで行った上で、テストアップロード、`PyPI` からのインストールまで確認。
# タスク
# 関連