Skip to content

Commit

Permalink
tuning a bit the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
JostTim committed Jan 8, 2024
1 parent db10dbd commit e554a90
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The flat layout structure is standardized like this :

> - :open_file_folder: PackageRepo
> - :page_facing_up: setup.py
> - :page_facing_up: auto-doc.py
> - :page_facing_up: pyproject.toml
> - :page_facing_up: mkdocs.yml
> - :open_file_folder: docs
> - :page_facing_up: index.md
Expand All @@ -84,7 +84,7 @@ While the src layout is standardized like this :

> - :open_file_folder: PackageRepo
> - :page_facing_up: setup.py
> - :page_facing_up: auto-doc.py
> - :page_facing_up: pyproject.toml
> - :page_facing_up: mkdocs.yml
> - :open_file_folder: docs
> - :page_facing_up: index.md
Expand All @@ -96,6 +96,10 @@ While the src layout is standardized like this :
> - :page_facing_up: \_\_init__.py
> - :page_facing_up: myfile2.py
Note that auto_fast_docs doesn't care about ``pyproject.toml`` or ``setup.py``, any can be used.
Also note that the docs folder, and the mkdocs.yml file here are both also not necessary, if you supply at least the ``--username`` option (see above)
(and of course, if you are on github on a user hosted repo. Otherwise, see ``--platform`` and ``--groups`` options below)

### --platform
The platform (``github`` or ``gitlab``) on wich you are building the pages into.
The default is ``github``
Expand Down

0 comments on commit e554a90

Please sign in to comment.