
Research
PyPI Package Disguised as Instagram Growth Tool Harvests User Credentials
A deceptive PyPI package posing as an Instagram growth tool collects user credentials and sends them to third-party bot services.
quartodoc lets you quickly generate Python package API reference documentation using Markdown and Quarto. quartodoc is designed as an alternative to Sphinx.
Check out the below screencast for a walkthrough of creating a documentation site, or read on for instructions.
python -m pip install quartodoc
or from GitHub
python -m pip install git+https://github.com/machow/quartodoc.git
[!IMPORTANT]
Install Quarto
If you haven’t already, you’ll need to install Quarto before you can use quartodoc.
Getting started with quartodoc takes two steps: configuring quartodoc, then generating documentation pages for your library.
You can configure quartodoc alongside the rest of your Quarto site in
the
_quarto.yml
file you are already using for Quarto. To configure
quartodoc,
you need to add a quartodoc
section to the top level your
_quarto.yml
file. Below is a minimal example of a configuration that
documents the quartodoc
package:
project:
type: website
# tell quarto to read the generated sidebar
metadata-files:
- reference/_sidebar.yml
# tell quarto to read the generated styles
format:
html:
css:
- reference/_styles-quartodoc.css
quartodoc:
# the name used to import the package you want to create reference docs for
package: quartodoc
# write sidebar and style data
sidebar: reference/_sidebar.yml
css: reference/_styles-quartodoc.css
sections:
- title: Some functions
desc: Functions to inspect docstrings.
contents:
# the functions being documented in the package.
# you can refer to anything: class methods, modules, etc..
- get_object
- preview
Now that you have configured quartodoc, you can generate the reference API docs with the following command:
quartodoc build
This will create a reference/
directory with an index.qmd
and
documentation pages for listed functions, like get_object
and
preview
.
Finally, preview your website with quarto:
quarto preview
You can preview your quartodoc
site using the following commands:
First, watch for changes to the library you are documenting so that your docs will automatically re-generate:
quartodoc build --watch
Second, preview your site:
quarto preview
Generating API reference docs for Python objects involves two pieces of configuration:
quartodoc can look up a wide variety of objects, including functions, modules, classes, attributes, and methods:
quartodoc:
package: quartodoc
sections:
- title: Some section
desc: ""
contents:
- get_object # function: quartodoc.get_object
- ast.preview # submodule func: quartodoc.ast.preview
- MdRenderer # class: quartodoc.MdRenderer
- MdRenderer.render # method: quartodoc.MDRenderer.render
- renderers # module: quartodoc.renderers
The functions listed in contents
are assumed to be imported from the
package.
Go to the next page to learn how to configure quartodoc sites, or check out these handy pages:
FAQs
Generate API documentation with Quarto.
We found that quartodoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
A deceptive PyPI package posing as an Instagram growth tool collects user credentials and sends them to third-party bot services.
Product
Socket now supports pylock.toml, enabling secure, reproducible Python builds with advanced scanning and full alignment with PEP 751's new standard.
Security News
Research
Socket uncovered two npm packages that register hidden HTTP endpoints to delete all files on command.