You will get Python Sphinx or Mkdocs documentation for software projects
Project details
Having a good documentation means that your users can enjoy your software or tutorial efficiently and in a short amount of time. There are lots of available tools, but Sphinx is a de-facto standard for Python. You can also use Sphinx for any kind of tutorials. Mkdocs is a valid alternative to Sphinx but it works with markdown instead of rst text files.
Sphinx can also read notes in the code and output beautiful documentation.
I can help you:
- document your API (for example Django) and/or create your tutorial from scratch
- write notes in your code so they can be read by Sphinx (docstrings)
- initialize Sphinx so that it can read function or class docstrings
- improve your existing documentation, also by adding references
- give you suggestions to improve your documentation
- help you fix problems to build the Sphinx documentation (extra)
- I also do it with mkdocs
Sphinx can generate output in various formats and the most commonly used is HTML.
I can write your documentation in English, Italian or French (this latter one I will use a translator and you will need to proofread it - I know basic French)
Sphinx can also read notes in the code and output beautiful documentation.
I can help you:
- document your API (for example Django) and/or create your tutorial from scratch
- write notes in your code so they can be read by Sphinx (docstrings)
- initialize Sphinx so that it can read function or class docstrings
- improve your existing documentation, also by adding references
- give you suggestions to improve your documentation
- help you fix problems to build the Sphinx documentation (extra)
- I also do it with mkdocs
Sphinx can generate output in various formats and the most commonly used is HTML.
I can write your documentation in English, Italian or French (this latter one I will use a translator and you will need to proofread it - I know basic French)
Document Type
DocumentationTopic
Blockchain, Software, Technology, GeneralLanguage
English, French, ItalianWhat's included
| Service Tiers |
Starter
$50
|
Standard
$75
|
Advanced
$90
|
|---|---|---|---|
| Delivery Time | 7 days | 10 days | 14 days |
Number of Revisions | 0 | 0 | 0 |
Consultation | - | - | - |
Proofreading & Editing | |||
Additional Research | - | - | |
References & Citations | - | - | |
Formatted Style Guide | - | - | - |
Frequently asked questions
About Franco
Software developer
Ferrara, Italy - 4:31 pm local time
These are the services I offer:
# Python and shell scripts (also consultations via video call)
- automation
- interacting with APIs
- scraping (BeautifulSoup, MechanicalSoup, Selenium, Requests)
- transform shell scripts into Python scripts
- etc
# Documentation in Sphinx or Mkdocs
- for your software
- for your API (including Django)
- docstrings
# Computer science lessons
- coding and programming (C,C++,Python,R,etc...)
- algorithms
- data structures
- networking
- databases
# Extras
- add accurate subtitles to videos
I have a degree in Computer Science. I develop and use Free/Libre Open Source Software (FLOSS), by passion, with a focus on self-hosting when possible.
My native language is Italian but I can also speak English and some French.
Steps for completing your project
After purchasing the project, send requirements so Franco can start the project.
Delivery time starts when Franco receives requirements from you.
Franco works on your project following the steps below.
Revisions may occur after the delivery date.
Basic environmental setup
I will setup the Sphinx or Mkdocs environment
Docstrings and API
If applicable to your project I will write docstrings for the API or the API section itself