mirror of https://github.com/eyhc1/rendercv.git
rename Code Documentation to API Reference
This commit is contained in:
parent
d2d7de01af
commit
db22505d0a
|
@ -85,7 +85,7 @@ cv:
|
||||||
|
|
||||||
A more detailed user guide can be found [here](https://sinaatalay.github.io/rendercv/user_guide).
|
A more detailed user guide can be found [here](https://sinaatalay.github.io/rendercv/user_guide).
|
||||||
|
|
||||||
I documented the whole code with docstrings and used comments throughout the code. The code documentation can be found [here](https://sinaatalay.github.io/rendercv/documentation/).
|
I documented the whole code with docstrings and used comments throughout the code. The API reference can be found [here](https://sinaatalay.github.io/rendercv/api_reference/).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|
10
mkdocs.yaml
10
mkdocs.yaml
|
@ -46,11 +46,11 @@ theme:
|
||||||
nav:
|
nav:
|
||||||
- Overview: index.md
|
- Overview: index.md
|
||||||
- User Guide: user_guide.md
|
- User Guide: user_guide.md
|
||||||
- Code Documentation:
|
- API Reference:
|
||||||
- Code Documentation: documentation/index.md
|
- API Reference: api_reference/index.md
|
||||||
- __main__.py: documentation/__main__.md
|
- __main__.py: api_reference/__main__.md
|
||||||
- data_model.py: documentation/data_model.md
|
- data_model.py: api_reference/data_model.md
|
||||||
- rendering.py: documentation/rendering.md
|
- rendering.py: api_reference/rendering.md
|
||||||
|
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
# see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info
|
# see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info
|
||||||
|
|
Loading…
Reference in New Issue