| Nov |
DEC |
Jan |
|
13 |
|
| 2024 |
2025 |
2026 |
About this capture
The Wayback Machine - http://web.archive.org/web/20251213203727/https://github.com/RustPython/__doc__
Skip to content
Navigation Menu
Appearance settings
AI CODE CREATION
GitHub CopilotWrite better code with AI
GitHub SparkBuild and deploy intelligent apps
GitHub ModelsManage and compare prompts
MCP RegistryNewIntegrate external tools
DEVELOPER WORKFLOWS
ActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
APPLICATION SECURITY
GitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLORE
●Why GitHub
●Documentation
●Blog
●Changelog
●Marketplace
View all features
BY COMPANY SIZE
●Enterprises
●Small and medium teams
●Startups
●Nonprofits
BY USE CASE
●App Modernization
●DevSecOps
●DevOps
●CI/CD
●View all use cases
BY INDUSTRY
●Healthcare
●Financial services
●Manufacturing
●Government
●View all industries
View all solutions
EXPLORE BY TOPIC
●AI
●Software Development
●DevOps
●Security
●View all topics
EXPLORE BY TYPE
●Customer stories
●Events & webinars
●Ebooks & reports
●Business insights
●GitHub Skills
SUPPORT & SERVICES
●Documentation
●Customer support
●Community forum
●Trust center
●Partners
COMMUNITY
GitHub SponsorsFund open source developers
PROGRAMS
●Security Lab
●Maintainer Community
●Accelerator
●Archive Program
REPOSITORIES
●Topics
●Trending
●Collections
ENTERPRISE SOLUTIONS
Enterprise platformAI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
●Pricing
Search or jump to...
Clear
Search syntax tips
Provide feedback
Saved searches
Use saved searches to filter your results more quickly
To see all available qualifiers, see our documentation.
Appearance settings
You signed in with another tab or window. Reload to refresh your session.
You signed out in another tab or window. Reload to refresh your session.
You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
{{ message }}
RustPython
/
__doc__
Public
●
Notifications
You must be signed in to change notification settings
●
Fork
5
Star
2
License
View license
2
stars
5
forks
Branches
Tags
Activity
Star
Notifications
You must be signed in to change notification settings
●
Code
●
Issues
0
●
Pull requests
0
●
Actions
●
Projects
0
●
Security
Uh oh!
There was an error while loading. Please reload this page.
●
Insights
Additional navigation options
●
Code
●
Issues
●
Pull requests
●
Actions
●
Projects
●
Security
●
Insights
RustPython/__doc__
main
BranchesTags
Open more actions menu
Folders and files
Repository files navigation
●README
●License
Important
This project is now archived and has been moved under RustPython
This is the __doc__ attributes generator for objects written in RustPython.
It's composed of two parts of:
●the generate_docs.py script that extracts the __doc__ attributes from CPython to docs.inc.rs
●the rustpython-doc rust crate that uses the docs.inc.rs file to create a documentation Database.
This documentation database is then used by macros pymodule and pyclass macros of the rustpython-derive crate to automatically add the __doc__ attribute.
The docs.inc.rs database file can be generated with
docs.inc.rs
$ deactivate">$ python -m venv gendocs
$ source gendocs/bin/activate
$ python -I generate_docs.py <path_to_RustPython> docs.inc.rs
$ deactivate
or using docker
$ docker pull python:slim
$ docker run python:slim python --version
Python 3.10.8
$ ls
__doc__ RustPython
$ docker run -v $(pwd):/RustPython -w /RustPython/__doc__ python:slim python generate_docs.py ../RustPython docs.inc.rs
and do not forget to update cargo before the test
$ cargo update
Why the __doc__ is not changed?
Check the old documentation implemented with remarks are still exist
RustPython prioritizes the user define documentation. Check if the old remarks are remaining in the source code. If it is, simply removing them could solve the issue.
Contributing
Contributions are more than welcome, and in many cases we are happy to guide
contributors through PRs or on gitter. Please refer to the
development guide as well for tips on developments.
License
This project is licensed under the MIT license. Please see the
LICENSE file for more details.
The project logo is licensed under the CC-BY-4.0
license. Please see the LICENSE-logo file
for more details.
About
No description or website provided.
Topics
hacktoberfest
Resources
Readme
License
View license
Uh oh!
There was an error while loading. Please reload this page.
Activity
Custom properties
Stars
2
stars
Watchers
3
watching
Forks
5
forks
Report repository
1
tags
No packages published
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Languages
●
Rust
98.7%
●
Python
1.3%
Footer
© 2025 GitHub, Inc.
●
Terms
●
Privacy
●
Security
●
Status
●
Community
●
Docs
●
Contact
●
●
ation
You can’t perform that action at this time.
