inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-12 01:55:39 +00:00
Code Activity

Documentation integration (#4653)

Browse Source 
* Add documentation under docs/ directory

* Add CI workflow for mkdocs configuration checking

* Add documentation issue template

* update pip-tools?

* Update .gitignore files

* Fix .gitignore rules

* Improve release notes page

* remove references to old repo
This commit is contained in:
Oliver
2023-04-22 22:40:29 +10:00
committed by GitHub
parent 20f01e8741
commit 2ffd2354eb
487 changed files with 44875 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/_includes/overrides/404.html Normal file
View File

@ -0,0 +1,29 @@
{% extends "base.html" %}
{% block tabs %}
{{ super() }}
{% endblock %}
{% block site_nav %}
{% endblock %}
{% block content %}
<style>
h1 {
font-family: Arial, Helvetica, sans-serif;
display: block;
}
</style>
<section class="mdx-container">
<div class="md-grid md-typeset">
<div class="mdx-hero"></div>
<h1>
<span class='fas fa-search'></span>
Page not found
</h1>
</div>
</section>
{% endblock %}

47
docs/_includes/overrides/home.html Normal file
View File

@ -0,0 +1,47 @@
{% extends "main.html" %}
{% block tabs %}
{{ super() }}
{% endblock %}
{% block content %}
{{ page.content }}
<style>
h1 {
font-family: Arial, Helvetica, sans-serif;
}
</style>
<!-- Hero for landing page -->
<section class="mdx-container">
<div class="md-grid md-typeset">
<div class="mdx-hero">
<!-- Hero content -->
<div class="mdx-hero__content">
<a href="https://inventree.org" title="InvenTree Website" class="md-button">
<span class='fas fa-globe'></span> Website
</a>
<a href="start/intro" title="Install InvenTree" class="md-button">
<span class='fas fa-server'></span> Install
</a>
<a href="app/app" title="InvenTree mobile app" class="md-button">
<span class='fas fa-mobile-alt'></span> Mobile App
</a>
<a href="https://crowdin.com/project/inventree" title="Help translate InvenTree" class="md-button">
<span class='fas fa-language'></span> Translate
</a>
<a href="https://github.com/inventree/inventree" title="Explore InvenTree source code" class="md-button md-button">
<span class='fab fa-github'></span> Source Code
</a>
</div>
</div>
</div>
</section>
{% endblock %}

6
docs/_includes/overrides/main.html Normal file
View File

@ -0,0 +1,6 @@
{% extends "base.html" %}
{% block header %}
{% include "partials/version_banner.html" %}
{% include "partials/header.html" %}
{% endblock %}

1
docs/_includes/overrides/partials/outdated.html Normal file
View File

@ -0,0 +1 @@
<!-- Empty "outdated" warning, we will handle this in 'banner.html' -->

15
docs/_includes/overrides/partials/version_banner.html Normal file
View File

@ -0,0 +1,15 @@
{% if config.version_banner %}
<div class='alert alert-warning alert-dismissable alert-version' role='alert'>
<div class='md-grid md-typeset'>
<small>
{% if config.readthedocs.version == 'latest' %}
This documentation is for the <em>development</em> version of InvenTree, which may be significantly different from the stable releases.
{% else %}
This documentation is for an outdated version of InvenTree.
{% endif %}
For <em>stable</em> release documentation, use the version selector located in the bottom right corner of this page.
</small>
<button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
</div>
</div>
{% endif %}